google-ads-api-client/dist/protos/bindings/google/rpc/context/attribute_context.d.ts

A friendly and exhaustive client to the google-ads-api, code generated directly from google's published protobuf schema.

import type { BinaryWriteOptions } from "@protobuf-ts/runtime";
import type { IBinaryWriter } from "@protobuf-ts/runtime";
import type { BinaryReadOptions } from "@protobuf-ts/runtime";
import type { IBinaryReader } from "@protobuf-ts/runtime";
import type { PartialMessage } from "@protobuf-ts/runtime";
import { MessageType } from "@protobuf-ts/runtime";
import { Duration } from "../../protobuf/duration";
import { Timestamp } from "../../protobuf/timestamp";
import { Struct } from "../../protobuf/struct";
import { Any } from "../../protobuf/any";
/**
 * This message defines the standard attribute vocabulary for Google APIs.
 *
 * An attribute is a piece of metadata that describes an activity on a network
 * service. For example, the size of an HTTP request, or the status code of
 * an HTTP response.
 *
 * Each attribute has a type and a name, which is logically defined as
 * a proto message field in `AttributeContext`. The field type becomes the
 * attribute type, and the field path becomes the attribute name. For example,
 * the attribute `source.ip` maps to field `AttributeContext.source.ip`.
 *
 * This message definition is guaranteed not to have any wire breaking change.
 * So you can use it directly for passing attributes across different systems.
 *
 * NOTE: Different system may generate different subset of attributes. Please
 * verify the system specification before relying on an attribute generated
 * a system.
 *
 * @generated from protobuf message google.rpc.context.AttributeContext
 */
export interface AttributeContext {
    /**
     * The origin of a network activity. In a multi hop network activity,
     * the origin represents the sender of the first hop. For the first hop,
     * the `source` and the `origin` must have the same content.
     *
     * @generated from protobuf field: google.rpc.context.AttributeContext.Peer origin = 7;
     */
    origin?: AttributeContext_Peer;
    /**
     * The source of a network activity, such as starting a TCP connection.
     * In a multi hop network activity, the source represents the sender of the
     * last hop.
     *
     * @generated from protobuf field: google.rpc.context.AttributeContext.Peer source = 1;
     */
    source?: AttributeContext_Peer;
    /**
     * The destination of a network activity, such as accepting a TCP connection.
     * In a multi hop network activity, the destination represents the receiver of
     * the last hop.
     *
     * @generated from protobuf field: google.rpc.context.AttributeContext.Peer destination = 2;
     */
    destination?: AttributeContext_Peer;
    /**
     * Represents a network request, such as an HTTP request.
     *
     * @generated from protobuf field: google.rpc.context.AttributeContext.Request request = 3;
     */
    request?: AttributeContext_Request;
    /**
     * Represents a network response, such as an HTTP response.
     *
     * @generated from protobuf field: google.rpc.context.AttributeContext.Response response = 4;
     */
    response?: AttributeContext_Response;
    /**
     * Represents a target resource that is involved with a network activity.
     * If multiple resources are involved with an activity, this must be the
     * primary one.
     *
     * @generated from protobuf field: google.rpc.context.AttributeContext.Resource resource = 5;
     */
    resource?: AttributeContext_Resource;
    /**
     * Represents an API operation that is involved to a network activity.
     *
     * @generated from protobuf field: google.rpc.context.AttributeContext.Api api = 6;
     */
    api?: AttributeContext_Api;
    /**
     * Supports extensions for advanced use cases, such as logs and metrics.
     *
     * @generated from protobuf field: repeated google.protobuf.Any extensions = 8;
     */
    extensions: Any[];
}
/**
 * This message defines attributes for a node that handles a network request.
 * The node can be either a service or an application that sends, forwards,
 * or receives the request. Service peers should fill in
 * `principal` and `labels` as appropriate.
 *
 * @generated from protobuf message google.rpc.context.AttributeContext.Peer
 */
export interface AttributeContext_Peer {
    /**
     * The IP address of the peer.
     *
     * @generated from protobuf field: string ip = 1;
     */
    ip: string;
    /**
     * The network port of the peer.
     *
     * @generated from protobuf field: int64 port = 2;
     */
    port: bigint;
    /**
     * The labels associated with the peer.
     *
     * @generated from protobuf field: map<string, string> labels = 6;
     */
    labels: {
        [key: string]: string;
    };
    /**
     * The identity of this peer. Similar to `Request.auth.principal`, but
     * relative to the peer instead of the request. For example, the
     * idenity associated with a load balancer that forwared the request.
     *
     * @generated from protobuf field: string principal = 7;
     */
    principal: string;
    /**
     * The CLDR country/region code associated with the above IP address.
     * If the IP address is private, the `region_code` should reflect the
     * physical location where this peer is running.
     *
     * @generated from protobuf field: string region_code = 8;
     */
    regionCode: string;
}
/**
 * This message defines attributes associated with API operations, such as
 * a network API request. The terminology is based on the conventions used
 * by Google APIs, Istio, and OpenAPI.
 *
 * @generated from protobuf message google.rpc.context.AttributeContext.Api
 */
export interface AttributeContext_Api {
    /**
     * The API service name. It is a logical identifier for a networked API,
     * such as "pubsub.googleapis.com". The naming syntax depends on the
     * API management system being used for handling the request.
     *
     * @generated from protobuf field: string service = 1;
     */
    service: string;
    /**
     * The API operation name. For gRPC requests, it is the fully qualified API
     * method name, such as "google.pubsub.v1.Publisher.Publish". For OpenAPI
     * requests, it is the `operationId`, such as "getPet".
     *
     * @generated from protobuf field: string operation = 2;
     */
    operation: string;
    /**
     * The API protocol used for sending the request, such as "http", "https",
     * "grpc", or "internal".
     *
     * @generated from protobuf field: string protocol = 3;
     */
    protocol: string;
    /**
     * The API version associated with the API operation above, such as "v1" or
     * "v1alpha1".
     *
     * @generated from protobuf field: string version = 4;
     */
    version: string;
}
/**
 * This message defines request authentication attributes. Terminology is
 * based on the JSON Web Token (JWT) standard, but the terms also
 * correlate to concepts in other standards.
 *
 * @generated from protobuf message google.rpc.context.AttributeContext.Auth
 */
export interface AttributeContext_Auth {
    /**
     * The authenticated principal. Reflects the issuer (`iss`) and subject
     * (`sub`) claims within a JWT. The issuer and subject should be `/`
     * delimited, with `/` percent-encoded within the subject fragment. For
     * Google accounts, the principal format is:
     * "https://accounts.google.com/{id}"
     *
     * @generated from protobuf field: string principal = 1;
     */
    principal: string;
    /**
     * The intended audience(s) for this authentication information. Reflects
     * the audience (`aud`) claim within a JWT. The audience
     * value(s) depends on the `issuer`, but typically include one or more of
     * the following pieces of information:
     *
     * *  The services intended to receive the credential. For example,
     *    ["https://pubsub.googleapis.com/", "https://storage.googleapis.com/"].
     * *  A set of service-based scopes. For example,
     *    ["https://www.googleapis.com/auth/cloud-platform"].
     * *  The client id of an app, such as the Firebase project id for JWTs
     *    from Firebase Auth.
     *
     * Consult the documentation for the credential issuer to determine the
     * information provided.
     *
     * @generated from protobuf field: repeated string audiences = 2;
     */
    audiences: string[];
    /**
     * The authorized presenter of the credential. Reflects the optional
     * Authorized Presenter (`azp`) claim within a JWT or the
     * OAuth client id. For example, a Google Cloud Platform client id looks
     * as follows: "123456789012.apps.googleusercontent.com".
     *
     * @generated from protobuf field: string presenter = 3;
     */
    presenter: string;
    /**
     * Structured claims presented with the credential. JWTs include
     * `{key: value}` pairs for standard and private claims. The following
     * is a subset of the standard required and optional claims that would
     * typically be presented for a Google-based JWT:
     *
     *    {'iss': 'accounts.google.com',
     *     'sub': '113289723416554971153',
     *     'aud': ['123456789012', 'pubsub.googleapis.com'],
     *     'azp': '123456789012.apps.googleusercontent.com',
     *     'email': 'jsmith@example.com',
     *     'iat': 1353601026,
     *     'exp': 1353604926}
     *
     * SAML assertions are similarly specified, but with an identity provider
     * dependent structure.
     *
     * @generated from protobuf field: google.protobuf.Struct claims = 4;
     */
    claims?: Struct;
    /**
     * A list of access level resource names that allow resources to be
     * accessed by authenticated requester. It is part of Secure GCP processing
     * for the incoming request. An access level string has the format:
     * "//{api_service_name}/accessPolicies/{policy_id}/accessLevels/{short_name}"
     *
     * Example:
     * "//accesscontextmanager.googleapis.com/accessPolicies/MY_POLICY_ID/accessLevels/MY_LEVEL"
     *
     * @generated from protobuf field: repeated string access_levels = 5;
     */
    accessLevels: string[];
}
/**
 * This message defines attributes for an HTTP request. If the actual
 * request is not an HTTP request, the runtime system should try to map
 * the actual request to an equivalent HTTP request.
 *
 * @generated from protobuf message google.rpc.context.AttributeContext.Request
 */
export interface AttributeContext_Request {
    /**
     * The unique ID for a request, which can be propagated to downstream
     * systems. The ID should have low probability of collision
     * within a single day for a specific service.
     *
     * @generated from protobuf field: string id = 1;
     */
    id: string;
    /**
     * The HTTP request method, such as `GET`, `POST`.
     *
     * @generated from protobuf field: string method = 2;
     */
    method: string;
    /**
     * The HTTP request headers. If multiple headers share the same key, they
     * must be merged according to the HTTP spec. All header keys must be
     * lowercased, because HTTP header keys are case-insensitive.
     *
     * @generated from protobuf field: map<string, string> headers = 3;
     */
    headers: {
        [key: string]: string;
    };
    /**
     * The HTTP URL path.
     *
     * @generated from protobuf field: string path = 4;
     */
    path: string;
    /**
     * The HTTP request `Host` header value.
     *
     * @generated from protobuf field: string host = 5;
     */
    host: string;
    /**
     * The HTTP URL scheme, such as `http` and `https`.
     *
     * @generated from protobuf field: string scheme = 6;
     */
    scheme: string;
    /**
     * The HTTP URL query in the format of `name1=value1&name2=value2`, as it
     * appears in the first line of the HTTP request. No decoding is performed.
     *
     * @generated from protobuf field: string query = 7;
     */
    query: string;
    /**
     * The timestamp when the `destination` service receives the last byte of
     * the request.
     *
     * @generated from protobuf field: google.protobuf.Timestamp time = 9;
     */
    time?: Timestamp;
    /**
     * The HTTP request size in bytes. If unknown, it must be -1.
     *
     * @generated from protobuf field: int64 size = 10;
     */
    size: bigint;
    /**
     * The network protocol used with the request, such as "http/1.1",
     * "spdy/3", "h2", "h2c", "webrtc", "tcp", "udp", "quic". See
     * https://www.iana.org/assignments/tls-extensiontype-values/tls-extensiontype-values.xhtml#alpn-protocol-ids
     * for details.
     *
     * @generated from protobuf field: string protocol = 11;
     */
    protocol: string;
    /**
     * A special parameter for request reason. It is used by security systems
     * to associate auditing information with a request.
     *
     * @generated from protobuf field: string reason = 12;
     */
    reason: string;
    /**
     * The request authentication. May be absent for unauthenticated requests.
     * Derived from the HTTP request `Authorization` header or equivalent.
     *
     * @generated from protobuf field: google.rpc.context.AttributeContext.Auth auth = 13;
     */
    auth?: AttributeContext_Auth;
}
/**
 * This message defines attributes for a typical network response. It
 * generally models semantics of an HTTP response.
 *
 * @generated from protobuf message google.rpc.context.AttributeContext.Response
 */
export interface AttributeContext_Response {
    /**
     * The HTTP response status code, such as `200` and `404`.
     *
     * @generated from protobuf field: int64 code = 1;
     */
    code: bigint;
    /**
     * The HTTP response size in bytes. If unknown, it must be -1.
     *
     * @generated from protobuf field: int64 size = 2;
     */
    size: bigint;
    /**
     * The HTTP response headers. If multiple headers share the same key, they
     * must be merged according to HTTP spec. All header keys must be
     * lowercased, because HTTP header keys are case-insensitive.
     *
     * @generated from protobuf field: map<string, string> headers = 3;
     */
    headers: {
        [key: string]: string;
    };
    /**
     * The timestamp when the `destination` service sends the last byte of
     * the response.
     *
     * @generated from protobuf field: google.protobuf.Timestamp time = 4;
     */
    time?: Timestamp;
    /**
     * The length of time it takes the backend service to fully respond to a
     * request. Measured from when the destination service starts to send the
     * request to the backend until when the destination service receives the
     * complete response from the backend.
     *
     * @generated from protobuf field: google.protobuf.Duration backend_latency = 5;
     */
    backendLatency?: Duration;
}
/**
 * This message defines core attributes for a resource. A resource is an
 * addressable (named) entity provided by the destination service. For
 * example, a file stored on a network storage service.
 *
 * @generated from protobuf message google.rpc.context.AttributeContext.Resource
 */
export interface AttributeContext_Resource {
    /**
     * The name of the service that this resource belongs to, such as
     * `pubsub.googleapis.com`. The service may be different from the DNS
     * hostname that actually serves the request.
     *
     * @generated from protobuf field: string service = 1;
     */
    service: string;
    /**
     * The stable identifier (name) of a resource on the `service`. A resource
     * can be logically identified as "//{resource.service}/{resource.name}".
     * The differences between a resource name and a URI are:
     *
     * *   Resource name is a logical identifier, independent of network
     *     protocol and API version. For example,
     *     `//pubsub.googleapis.com/projects/123/topics/news-feed`.
     * *   URI often includes protocol and version information, so it can
     *     be used directly by applications. For example,
     *     `https://pubsub.googleapis.com/v1/projects/123/topics/news-feed`.
     *
     * See https://cloud.google.com/apis/design/resource_names for details.
     *
     * @generated from protobuf field: string name = 2;
     */
    name: string;
    /**
     * The type of the resource. The syntax is platform-specific because
     * different platforms define their resources differently.
     *
     * For Google APIs, the type format must be "{service}/{kind}".
     *
     * @generated from protobuf field: string type = 3;
     */
    type: string;
    /**
     * The labels or tags on the resource, such as AWS resource tags and
     * Kubernetes resource labels.
     *
     * @generated from protobuf field: map<string, string> labels = 4;
     */
    labels: {
        [key: string]: string;
    };
    /**
     * The unique identifier of the resource. UID is unique in the time
     * and space for this resource within the scope of the service. It is
     * typically generated by the server on successful creation of a resource
     * and must not be changed. UID is used to uniquely identify resources
     * with resource name reuses. This should be a UUID4.
     *
     * @generated from protobuf field: string uid = 5;
     */
    uid: string;
    /**
     * Annotations is an unstructured key-value map stored with a resource that
     * may be set by external tools to store and retrieve arbitrary metadata.
     * They are not queryable and should be preserved when modifying objects.
     *
     * More info: https://kubernetes.io/docs/user-guide/annotations
     *
     * @generated from protobuf field: map<string, string> annotations = 6;
     */
    annotations: {
        [key: string]: string;
    };
    /**
     * Mutable. The display name set by clients. Must be <= 63 characters.
     *
     * @generated from protobuf field: string display_name = 7;
     */
    displayName: string;
    /**
     * Output only. The timestamp when the resource was created. This may
     * be either the time creation was initiated or when it was completed.
     *
     * @generated from protobuf field: google.protobuf.Timestamp create_time = 8;
     */
    createTime?: Timestamp;
    /**
     * Output only. The timestamp when the resource was last updated. Any
     * change to the resource made by users must refresh this value.
     * Changes to a resource made by the service should refresh this value.
     *
     * @generated from protobuf field: google.protobuf.Timestamp update_time = 9;
     */
    updateTime?: Timestamp;
    /**
     * Output only. The timestamp when the resource was deleted.
     * If the resource is not deleted, this must be empty.
     *
     * @generated from protobuf field: google.protobuf.Timestamp delete_time = 10;
     */
    deleteTime?: Timestamp;
    /**
     * Output only. An opaque value that uniquely identifies a version or
     * generation of a resource. It can be used to confirm that the client
     * and server agree on the ordering of a resource being written.
     *
     * @generated from protobuf field: string etag = 11;
     */
    etag: string;
    /**
     * Immutable. The location of the resource. The location encoding is
     * specific to the service provider, and new encoding may be introduced
     * as the service evolves.
     *
     * For Google Cloud products, the encoding is what is used by Google Cloud
     * APIs, such as `us-east1`, `aws-us-east-1`, and `azure-eastus2`. The
     * semantics of `location` is identical to the
     * `cloud.googleapis.com/location` label used by some Google Cloud APIs.
     *
     * @generated from protobuf field: string location = 12;
     */
    location: string;
}
declare class AttributeContext$Type extends MessageType<AttributeContext> {
    constructor();
    create(value?: PartialMessage<AttributeContext>): AttributeContext;
    internalBinaryRead(reader: IBinaryReader, length: number, options: BinaryReadOptions, target?: AttributeContext): AttributeContext;
    internalBinaryWrite(message: AttributeContext, writer: IBinaryWriter, options: BinaryWriteOptions): IBinaryWriter;
}
/**
 * @generated MessageType for protobuf message google.rpc.context.AttributeContext
 */
export declare const AttributeContext: AttributeContext$Type;
declare class AttributeContext_Peer$Type extends MessageType<AttributeContext_Peer> {
    constructor();
    create(value?: PartialMessage<AttributeContext_Peer>): AttributeContext_Peer;
    internalBinaryRead(reader: IBinaryReader, length: number, options: BinaryReadOptions, target?: AttributeContext_Peer): AttributeContext_Peer;
    private binaryReadMap6;
    internalBinaryWrite(message: AttributeContext_Peer, writer: IBinaryWriter, options: BinaryWriteOptions): IBinaryWriter;
}
/**
 * @generated MessageType for protobuf message google.rpc.context.AttributeContext.Peer
 */
export declare const AttributeContext_Peer: AttributeContext_Peer$Type;
declare class AttributeContext_Api$Type extends MessageType<AttributeContext_Api> {
    constructor();
    create(value?: PartialMessage<AttributeContext_Api>): AttributeContext_Api;
    internalBinaryRead(reader: IBinaryReader, length: number, options: BinaryReadOptions, target?: AttributeContext_Api): AttributeContext_Api;
    internalBinaryWrite(message: AttributeContext_Api, writer: IBinaryWriter, options: BinaryWriteOptions): IBinaryWriter;
}
/**
 * @generated MessageType for protobuf message google.rpc.context.AttributeContext.Api
 */
export declare const AttributeContext_Api: AttributeContext_Api$Type;
declare class AttributeContext_Auth$Type extends MessageType<AttributeContext_Auth> {
    constructor();
    create(value?: PartialMessage<AttributeContext_Auth>): AttributeContext_Auth;
    internalBinaryRead(reader: IBinaryReader, length: number, options: BinaryReadOptions, target?: AttributeContext_Auth): AttributeContext_Auth;
    internalBinaryWrite(message: AttributeContext_Auth, writer: IBinaryWriter, options: BinaryWriteOptions): IBinaryWriter;
}
/**
 * @generated MessageType for protobuf message google.rpc.context.AttributeContext.Auth
 */
export declare const AttributeContext_Auth: AttributeContext_Auth$Type;
declare class AttributeContext_Request$Type extends MessageType<AttributeContext_Request> {
    constructor();
    create(value?: PartialMessage<AttributeContext_Request>): AttributeContext_Request;
    internalBinaryRead(reader: IBinaryReader, length: number, options: BinaryReadOptions, target?: AttributeContext_Request): AttributeContext_Request;
    private binaryReadMap3;
    internalBinaryWrite(message: AttributeContext_Request, writer: IBinaryWriter, options: BinaryWriteOptions): IBinaryWriter;
}
/**
 * @generated MessageType for protobuf message google.rpc.context.AttributeContext.Request
 */
export declare const AttributeContext_Request: AttributeContext_Request$Type;
declare class AttributeContext_Response$Type extends MessageType<AttributeContext_Response> {
    constructor();
    create(value?: PartialMessage<AttributeContext_Response>): AttributeContext_Response;
    internalBinaryRead(reader: IBinaryReader, length: number, options: BinaryReadOptions, target?: AttributeContext_Response): AttributeContext_Response;
    private binaryReadMap3;
    internalBinaryWrite(message: AttributeContext_Response, writer: IBinaryWriter, options: BinaryWriteOptions): IBinaryWriter;
}
/**
 * @generated MessageType for protobuf message google.rpc.context.AttributeContext.Response
 */
export declare const AttributeContext_Response: AttributeContext_Response$Type;
declare class AttributeContext_Resource$Type extends MessageType<AttributeContext_Resource> {
    constructor();
    create(value?: PartialMessage<AttributeContext_Resource>): AttributeContext_Resource;
    internalBinaryRead(reader: IBinaryReader, length: number, options: BinaryReadOptions, target?: AttributeContext_Resource): AttributeContext_Resource;
    private binaryReadMap4;
    private binaryReadMap6;
    internalBinaryWrite(message: AttributeContext_Resource, writer: IBinaryWriter, options: BinaryWriteOptions): IBinaryWriter;
}
/**
 * @generated MessageType for protobuf message google.rpc.context.AttributeContext.Resource
 */
export declare const AttributeContext_Resource: AttributeContext_Resource$Type;
export {};