Attributes
- Companion:
- class
- Source:
- AttributeContext.scala
- Graph
- Supertypes
- trait Producttrait Mirrortrait GeneratedMessageCompanion[AttributeContext]trait Serializableclass Objecttrait Matchableclass Any
- Self type
- AttributeContext.type
Members list
Type members
Classlikes
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.
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.
Attributes
- operation
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".- protocol
The API protocol used for sending the request, such as "http", "https", "grpc", or "internal".
- service
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.
- version
The API version associated with the API operation above, such as "v1" or "v1alpha1".
- Companion:
- object
- Source:
- AttributeContext.scala
- Graph
- Supertypes
Attributes
- Companion:
- class
- Source:
- AttributeContext.scala
- Graph
- Supertypes
- trait Producttrait Mirrortrait GeneratedMessageCompanion[Api]trait Serializableclass Objecttrait Matchableclass Any
- Self type
- Api.type
Attributes
- Source:
- AttributeContext.scala
- Graph
- Supertypes
- trait Serializableclass Objecttrait Matchableclass Any
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.
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.
Attributes
- accessLevels
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"
- audiences
The intended audience(s) for this authentication information. Reflects the audience (
aud
) claim within a JWT. The audience value(s) depends on theissuer
, 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.
- claims
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': '[email protected]', 'iat': 1353601026, 'exp': 1353604926} SAML assertions are similarly specified, but with an identity provider dependent structure.- presenter
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".- principal
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}"- Companion:
- object
- Source:
- AttributeContext.scala
- Graph
- Supertypes
Attributes
- Companion:
- class
- Source:
- AttributeContext.scala
- Graph
- Supertypes
- trait Producttrait Mirrortrait GeneratedMessageCompanion[Auth]trait Serializableclass Objecttrait Matchableclass Any
- Self type
- Auth.type
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.
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.
Attributes
- ip
The IP address of the peer.
- labels
The labels associated with the peer.
- port
The network port of the peer.
- principal
The identity of this peer. Similar to
Request.auth.principal
, but relative to the peer instead of the request. For example, the identity associated with a load balancer that forwarded the request.- regionCode
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.- Companion:
- object
- Source:
- AttributeContext.scala
- Graph
- Supertypes
Attributes
- Companion:
- class
- Source:
- AttributeContext.scala
- Graph
- Supertypes
- trait Producttrait Mirrortrait GeneratedMessageCompanion[Peer]trait Serializableclass Objecttrait Matchableclass Any
- Self type
- Peer.type
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.
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.
Attributes
- auth
The request authentication. May be absent for unauthenticated requests. Derived from the HTTP request
Authorization
header or equivalent.- headers
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.
- host
The HTTP request
Host
header value.- id
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.
- method
The HTTP request method, such as
GET
,POST
.- path
The HTTP URL path, excluding the query parameters.
- protocol
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.
- query
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.- reason
A special parameter for request reason. It is used by security systems to associate auditing information with a request.
- scheme
The HTTP URL scheme, such as
http
andhttps
.- size
The HTTP request size in bytes. If unknown, it must be -1.
- time
The timestamp when the
destination
service receives the last byte of the request.- Companion:
- object
- Source:
- AttributeContext.scala
- Graph
- Supertypes
Attributes
- Companion:
- class
- Source:
- AttributeContext.scala
- Graph
- Supertypes
- trait Producttrait Mirrortrait GeneratedMessageCompanion[Request]trait Serializableclass Objecttrait Matchableclass Any
- Self type
- Request.type
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.
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.
Attributes
- annotations
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
- createTime
Output only. The timestamp when the resource was created. This may be either the time creation was initiated or when it was completed.
- deleteTime
Output only. The timestamp when the resource was deleted. If the resource is not deleted, this must be empty.
- displayName
Mutable. The display name set by clients. Must be <= 63 characters.
- etag
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.
- labels
The labels or tags on the resource, such as AWS resource tags and Kubernetes resource labels.
- location
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
, andazure-eastus2
. The semantics oflocation
is identical to thecloud.googleapis.com/location
label used by some Google Cloud APIs.- name
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.
- Resource name is a logical identifier, independent of network
protocol and API version. For example,
- service
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.- type
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}", such as "pubsub.googleapis.com/Topic".
- uid
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.
- updateTime
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.
- Companion:
- object
- Source:
- AttributeContext.scala
- Graph
- Supertypes
Attributes
- Companion:
- class
- Source:
- AttributeContext.scala
- Graph
- Supertypes
- trait Producttrait Mirrortrait GeneratedMessageCompanion[Resource]trait Serializableclass Objecttrait Matchableclass Any
- Self type
- Resource.type
This message defines attributes for a typical network response. It generally models semantics of an HTTP response.
This message defines attributes for a typical network response. It generally models semantics of an HTTP response.
Attributes
- backendLatency
The amount 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.
- code
The HTTP response status code, such as
200
and404
.- headers
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.
- size
The HTTP response size in bytes. If unknown, it must be -1.
- time
The timestamp when the
destination
service sends the last byte of the response.- Companion:
- object
- Source:
- AttributeContext.scala
- Graph
- Supertypes
Inherited types
The names of the product elements
The name of the type
Attributes
- Inherited from:
- GeneratedMessageCompanion
- Source:
- GeneratedMessageCompanion.scala
Value members
Concrete methods
Attributes
- Source:
- AttributeContext.scala
Returns the Java descriptors for this message. It is recommended to use scalaDescriptors. The Java descriptors are available even when Java conversions is disabled, however they are not available in Scala.js or scala-native.
Returns the Java descriptors for this message. It is recommended to use scalaDescriptors. The Java descriptors are available even when Java conversions is disabled, however they are not available in Scala.js or scala-native.
Attributes
- Source:
- AttributeContext.scala
Attributes
- Source:
- AttributeContext.scala
Attributes
- Source:
- AttributeContext.scala
Parses a message from a CodedInputStream.
Attributes
- Source:
- AttributeContext.scala
Inherited methods
Attributes
- Inherited from:
- GeneratedMessageCompanion
- Source:
- GeneratedMessageCompanion.scala
Attributes
- Inherited from:
- GeneratedMessageCompanion
- Source:
- GeneratedMessageCompanion.scala
Merges the given message with the additional fields in the steam.
Merges the given message with the additional fields in the steam.
Attributes
- Inherited from:
- GeneratedMessageCompanion
- Source:
- GeneratedMessageCompanion.scala
Attributes
- Inherited from:
- GeneratedMessageCompanion
- Source:
- GeneratedMessageCompanion.scala
Attributes
- Inherited from:
- GeneratedMessageCompanion
- Source:
- GeneratedMessageCompanion.scala
Attributes
- Inherited from:
- GeneratedMessageCompanion
- Source:
- GeneratedMessageCompanion.scala
Attributes
- Inherited from:
- GeneratedMessageCompanion
- Source:
- GeneratedMessageCompanion.scala
Attributes
- Inherited from:
- GeneratedMessageCompanion
- Source:
- GeneratedMessageCompanion.scala
Attributes
- Inherited from:
- GeneratedMessageCompanion
- Source:
- GeneratedMessageCompanion.scala
Attributes
- Inherited from:
- GeneratedMessageCompanion
- Source:
- GeneratedMessageCompanion.scala
Attributes
- Inherited from:
- GeneratedMessageCompanion
- Source:
- GeneratedMessageCompanion.scala
Attributes
- Inherited from:
- GeneratedMessageCompanion
- Source:
- GeneratedMessageCompanion.scala
Concrete fields
Attributes
- Source:
- AttributeContext.scala
Attributes
- Source:
- AttributeContext.scala
Attributes
- Source:
- AttributeContext.scala
Attributes
- Source:
- AttributeContext.scala
Attributes
- Source:
- AttributeContext.scala
Attributes
- Source:
- AttributeContext.scala
Attributes
- Source:
- AttributeContext.scala
Attributes
- Source:
- AttributeContext.scala
Attributes
- Source:
- AttributeContext.scala
Attributes
- Source:
- AttributeContext.scala
Implicits
Implicits
Attributes
- Source:
- AttributeContext.scala
Attributes
- Source:
- AttributeContext.scala
Attributes
- Source:
- AttributeContext.scala