Package com.google.rpc.context

Interface AttributeContext.ResourceOrBuilder

    • Method Summary

      All Methods Instance Methods Abstract Methods Deprecated Methods 
      Modifier and Type Method Description
      boolean containsAnnotations​(String key)
      Annotations is an unstructured key-value map stored with a resource that may be set by external tools to store and retrieve arbitrary metadata.
      boolean containsLabels​(String key)
      The labels or tags on the resource, such as AWS resource tags and Kubernetes resource labels.
      Map<String,​String> getAnnotations()
      Deprecated.
      int getAnnotationsCount()
      Annotations is an unstructured key-value map stored with a resource that may be set by external tools to store and retrieve arbitrary metadata.
      Map<String,​String> getAnnotationsMap()
      Annotations is an unstructured key-value map stored with a resource that may be set by external tools to store and retrieve arbitrary metadata.
      String getAnnotationsOrDefault​(String key, String defaultValue)
      Annotations is an unstructured key-value map stored with a resource that may be set by external tools to store and retrieve arbitrary metadata.
      String getAnnotationsOrThrow​(String key)
      Annotations is an unstructured key-value map stored with a resource that may be set by external tools to store and retrieve arbitrary metadata.
      com.google.protobuf.Timestamp getCreateTime()
      Output only.
      com.google.protobuf.TimestampOrBuilder getCreateTimeOrBuilder()
      Output only.
      com.google.protobuf.Timestamp getDeleteTime()
      Output only.
      com.google.protobuf.TimestampOrBuilder getDeleteTimeOrBuilder()
      Output only.
      String getDisplayName()
      Mutable.
      com.google.protobuf.ByteString getDisplayNameBytes()
      Mutable.
      String getEtag()
      Output only.
      com.google.protobuf.ByteString getEtagBytes()
      Output only.
      Map<String,​String> getLabels()
      Deprecated.
      int getLabelsCount()
      The labels or tags on the resource, such as AWS resource tags and Kubernetes resource labels.
      Map<String,​String> getLabelsMap()
      The labels or tags on the resource, such as AWS resource tags and Kubernetes resource labels.
      String getLabelsOrDefault​(String key, String defaultValue)
      The labels or tags on the resource, such as AWS resource tags and Kubernetes resource labels.
      String getLabelsOrThrow​(String key)
      The labels or tags on the resource, such as AWS resource tags and Kubernetes resource labels.
      String getLocation()
      Immutable.
      com.google.protobuf.ByteString getLocationBytes()
      Immutable.
      String getName()
      The stable identifier (name) of a resource on the `service`.
      com.google.protobuf.ByteString getNameBytes()
      The stable identifier (name) of a resource on the `service`.
      String getService()
      The name of the service that this resource belongs to, such as `pubsub.googleapis.com`.
      com.google.protobuf.ByteString getServiceBytes()
      The name of the service that this resource belongs to, such as `pubsub.googleapis.com`.
      String getType()
      The type of the resource.
      com.google.protobuf.ByteString getTypeBytes()
      The type of the resource.
      String getUid()
      The unique identifier of the resource.
      com.google.protobuf.ByteString getUidBytes()
      The unique identifier of the resource.
      com.google.protobuf.Timestamp getUpdateTime()
      Output only.
      com.google.protobuf.TimestampOrBuilder getUpdateTimeOrBuilder()
      Output only.
      boolean hasCreateTime()
      Output only.
      boolean hasDeleteTime()
      Output only.
      boolean hasUpdateTime()
      Output only.

      • Methods inherited from interface com.google.protobuf.MessageLiteOrBuilder

        isInitialized

      • Methods inherited from interface com.google.protobuf.MessageOrBuilder

        findInitializationErrors, getAllFields, getDefaultInstanceForType, getDescriptorForType, getField, getInitializationErrorString, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, getUnknownFields, hasField, hasOneof

    • Method Detail

      • getService

        String getService()
         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.
        string service = 1;
        Returns:
        The service.

      • getServiceBytes

        com.google.protobuf.ByteString getServiceBytes()
         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.
        string service = 1;
        Returns:
        The bytes for service.

      • getName

        String getName()
         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.
        string name = 2;
        Returns:
        The name.

      • getNameBytes

        com.google.protobuf.ByteString getNameBytes()
         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.
        string name = 2;
        Returns:
        The bytes for name.

      • getType

        String getType()
         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".
        string type = 3;
        Returns:
        The type.

      • getTypeBytes

        com.google.protobuf.ByteString getTypeBytes()
         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".
        string type = 3;
        Returns:
        The bytes for type.

      • getLabelsCount

        int getLabelsCount()
         The labels or tags on the resource, such as AWS resource tags and
 Kubernetes resource labels.
        map<string, string> labels = 4;

      • containsLabels

        boolean containsLabels​(String key)
         The labels or tags on the resource, such as AWS resource tags and
 Kubernetes resource labels.
        map<string, string> labels = 4;

      • getLabelsMap

        Map<String,​String> getLabelsMap()
         The labels or tags on the resource, such as AWS resource tags and
 Kubernetes resource labels.
        map<string, string> labels = 4;

      • getLabelsOrDefault

        String getLabelsOrDefault​(String key,
                          String defaultValue)
         The labels or tags on the resource, such as AWS resource tags and
 Kubernetes resource labels.
        map<string, string> labels = 4;

      • getLabelsOrThrow

        String getLabelsOrThrow​(String key)
         The labels or tags on the resource, such as AWS resource tags and
 Kubernetes resource labels.
        map<string, string> labels = 4;

      • getUid

        String getUid()
         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.
        string uid = 5;
        Returns:
        The uid.

      • getUidBytes

        com.google.protobuf.ByteString getUidBytes()
         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.
        string uid = 5;
        Returns:
        The bytes for uid.

      • getAnnotationsCount

        int getAnnotationsCount()
         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
        map<string, string> annotations = 6;

      • containsAnnotations

        boolean containsAnnotations​(String key)
         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
        map<string, string> annotations = 6;

      • getAnnotationsMap

        Map<String,​String> getAnnotationsMap()
         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
        map<string, string> annotations = 6;

      • getAnnotationsOrDefault

        String getAnnotationsOrDefault​(String key,
                               String defaultValue)
         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
        map<string, string> annotations = 6;

      • getAnnotationsOrThrow

        String getAnnotationsOrThrow​(String key)
         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
        map<string, string> annotations = 6;

      • getDisplayName

        String getDisplayName()
         Mutable. The display name set by clients. Must be <= 63 characters.
        string display_name = 7;
        Returns:
        The displayName.

      • getDisplayNameBytes

        com.google.protobuf.ByteString getDisplayNameBytes()
         Mutable. The display name set by clients. Must be <= 63 characters.
        string display_name = 7;
        Returns:
        The bytes for displayName.

      • hasCreateTime

        boolean hasCreateTime()
         Output only. The timestamp when the resource was created. This may
 be either the time creation was initiated or when it was completed.
        .google.protobuf.Timestamp create_time = 8;
        Returns:
        Whether the createTime field is set.

      • getCreateTime

        com.google.protobuf.Timestamp getCreateTime()
         Output only. The timestamp when the resource was created. This may
 be either the time creation was initiated or when it was completed.
        .google.protobuf.Timestamp create_time = 8;
        Returns:
        The createTime.

      • getCreateTimeOrBuilder

        com.google.protobuf.TimestampOrBuilder getCreateTimeOrBuilder()
         Output only. The timestamp when the resource was created. This may
 be either the time creation was initiated or when it was completed.
        .google.protobuf.Timestamp create_time = 8;

      • hasUpdateTime

        boolean hasUpdateTime()
         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.
        .google.protobuf.Timestamp update_time = 9;
        Returns:
        Whether the updateTime field is set.

      • getUpdateTime

        com.google.protobuf.Timestamp getUpdateTime()
         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.
        .google.protobuf.Timestamp update_time = 9;
        Returns:
        The updateTime.

      • getUpdateTimeOrBuilder

        com.google.protobuf.TimestampOrBuilder getUpdateTimeOrBuilder()
         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.
        .google.protobuf.Timestamp update_time = 9;

      • hasDeleteTime

        boolean hasDeleteTime()
         Output only. The timestamp when the resource was deleted.
 If the resource is not deleted, this must be empty.
        .google.protobuf.Timestamp delete_time = 10;
        Returns:
        Whether the deleteTime field is set.

      • getDeleteTime

        com.google.protobuf.Timestamp getDeleteTime()
         Output only. The timestamp when the resource was deleted.
 If the resource is not deleted, this must be empty.
        .google.protobuf.Timestamp delete_time = 10;
        Returns:
        The deleteTime.

      • getDeleteTimeOrBuilder

        com.google.protobuf.TimestampOrBuilder getDeleteTimeOrBuilder()
         Output only. The timestamp when the resource was deleted.
 If the resource is not deleted, this must be empty.
        .google.protobuf.Timestamp delete_time = 10;

      • getEtag

        String getEtag()
         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.
        string etag = 11;
        Returns:
        The etag.

      • getEtagBytes

        com.google.protobuf.ByteString getEtagBytes()
         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.
        string etag = 11;
        Returns:
        The bytes for etag.

      • getLocation

        String getLocation()
         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.
        string location = 12;
        Returns:
        The location.

      • getLocationBytes

        com.google.protobuf.ByteString getLocationBytes()
         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.
        string location = 12;
        Returns:
        The bytes for location.