Package com.google.api.apikeys.v2

Interface KeyOrBuilder

All Superinterfaces:
com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder
All Known Implementing Classes:
Key, Key.Builder
@Generated public interface KeyOrBuilder extends com.google.protobuf.MessageOrBuilder

  • Method Details

    • getName

      String getName()
       Output only. The resource name of the key.
 The `name` has the form:
 `projects/<PROJECT_NUMBER>/locations/global/keys/<KEY_ID>`.
 For example:
 `projects/123456867718/locations/global/keys/b7ff1f9f-8275-410a-94dd-3855ee9b5dd2`

 NOTE: Key is a global resource; hence the only supported value for
 location is `global`.
      string name = 1 [(.google.api.field_behavior) = OUTPUT_ONLY];
      Returns:
      The name.

    • getNameBytes

      com.google.protobuf.ByteString getNameBytes()
       Output only. The resource name of the key.
 The `name` has the form:
 `projects/<PROJECT_NUMBER>/locations/global/keys/<KEY_ID>`.
 For example:
 `projects/123456867718/locations/global/keys/b7ff1f9f-8275-410a-94dd-3855ee9b5dd2`

 NOTE: Key is a global resource; hence the only supported value for
 location is `global`.
      string name = 1 [(.google.api.field_behavior) = OUTPUT_ONLY];
      Returns:
      The bytes for name.

    • getUid

      String getUid()
       Output only. Unique id in UUID4 format.
      string uid = 5 [(.google.api.field_behavior) = OUTPUT_ONLY];
      Returns:
      The uid.

    • getUidBytes

      com.google.protobuf.ByteString getUidBytes()
       Output only. Unique id in UUID4 format.
      string uid = 5 [(.google.api.field_behavior) = OUTPUT_ONLY];
      Returns:
      The bytes for uid.

    • getDisplayName

      String getDisplayName()
       Human-readable display name of this key that you can modify.
 The maximum length is 63 characters.
      string display_name = 2;
      Returns:
      The displayName.

    • getDisplayNameBytes

      com.google.protobuf.ByteString getDisplayNameBytes()
       Human-readable display name of this key that you can modify.
 The maximum length is 63 characters.
      string display_name = 2;
      Returns:
      The bytes for displayName.

    • getKeyString

      String getKeyString()
       Output only. An encrypted and signed value held by this key.
 This field can be accessed only through the `GetKeyString` method.
      string key_string = 3 [(.google.api.field_behavior) = OUTPUT_ONLY];
      Returns:
      The keyString.

    • getKeyStringBytes

      com.google.protobuf.ByteString getKeyStringBytes()
       Output only. An encrypted and signed value held by this key.
 This field can be accessed only through the `GetKeyString` method.
      string key_string = 3 [(.google.api.field_behavior) = OUTPUT_ONLY];
      Returns:
      The bytes for keyString.

    • hasCreateTime

      boolean hasCreateTime()
       Output only. A timestamp identifying the time this key was originally
 created.
      .google.protobuf.Timestamp create_time = 4 [(.google.api.field_behavior) = OUTPUT_ONLY];
      Returns:
      Whether the createTime field is set.

    • getCreateTime

      com.google.protobuf.Timestamp getCreateTime()
       Output only. A timestamp identifying the time this key was originally
 created.
      .google.protobuf.Timestamp create_time = 4 [(.google.api.field_behavior) = OUTPUT_ONLY];
      Returns:
      The createTime.

    • getCreateTimeOrBuilder

      com.google.protobuf.TimestampOrBuilder getCreateTimeOrBuilder()
       Output only. A timestamp identifying the time this key was originally
 created.
      .google.protobuf.Timestamp create_time = 4 [(.google.api.field_behavior) = OUTPUT_ONLY];

    • hasUpdateTime

      boolean hasUpdateTime()
       Output only. A timestamp identifying the time this key was last
 updated.
      .google.protobuf.Timestamp update_time = 6 [(.google.api.field_behavior) = OUTPUT_ONLY];
      Returns:
      Whether the updateTime field is set.

    • getUpdateTime

      com.google.protobuf.Timestamp getUpdateTime()
       Output only. A timestamp identifying the time this key was last
 updated.
      .google.protobuf.Timestamp update_time = 6 [(.google.api.field_behavior) = OUTPUT_ONLY];
      Returns:
      The updateTime.

    • getUpdateTimeOrBuilder

      com.google.protobuf.TimestampOrBuilder getUpdateTimeOrBuilder()
       Output only. A timestamp identifying the time this key was last
 updated.
      .google.protobuf.Timestamp update_time = 6 [(.google.api.field_behavior) = OUTPUT_ONLY];

    • hasDeleteTime

      boolean hasDeleteTime()
       Output only. A timestamp when this key was deleted. If the resource is not
 deleted, this must be empty.
      .google.protobuf.Timestamp delete_time = 7 [(.google.api.field_behavior) = OUTPUT_ONLY];
      Returns:
      Whether the deleteTime field is set.

    • getDeleteTime

      com.google.protobuf.Timestamp getDeleteTime()
       Output only. A timestamp when this key was deleted. If the resource is not
 deleted, this must be empty.
      .google.protobuf.Timestamp delete_time = 7 [(.google.api.field_behavior) = OUTPUT_ONLY];
      Returns:
      The deleteTime.

    • getDeleteTimeOrBuilder

      com.google.protobuf.TimestampOrBuilder getDeleteTimeOrBuilder()
       Output only. A timestamp when this key was deleted. If the resource is not
 deleted, this must be empty.
      .google.protobuf.Timestamp delete_time = 7 [(.google.api.field_behavior) = OUTPUT_ONLY];

    • getAnnotationsCount

      int getAnnotationsCount()
       Annotations is an unstructured key-value map stored with a policy that
 may be set by external tools to store and retrieve arbitrary metadata.
 They are not queryable and should be preserved when modifying objects.
      map<string, string> annotations = 8;

    • containsAnnotations

      boolean containsAnnotations(String key)
       Annotations is an unstructured key-value map stored with a policy that
 may be set by external tools to store and retrieve arbitrary metadata.
 They are not queryable and should be preserved when modifying objects.
      map<string, string> annotations = 8;

    • getAnnotations

      @Deprecated Map<String,String> getAnnotations()
      Deprecated.
      Use getAnnotationsMap() instead.

    • getAnnotationsMap

      Map<String,String> getAnnotationsMap()
       Annotations is an unstructured key-value map stored with a policy that
 may be set by external tools to store and retrieve arbitrary metadata.
 They are not queryable and should be preserved when modifying objects.
      map<string, string> annotations = 8;

    • getAnnotationsOrDefault

      String getAnnotationsOrDefault(String key, String defaultValue)
       Annotations is an unstructured key-value map stored with a policy that
 may be set by external tools to store and retrieve arbitrary metadata.
 They are not queryable and should be preserved when modifying objects.
      map<string, string> annotations = 8;

    • getAnnotationsOrThrow

      String getAnnotationsOrThrow(String key)
       Annotations is an unstructured key-value map stored with a policy that
 may be set by external tools to store and retrieve arbitrary metadata.
 They are not queryable and should be preserved when modifying objects.
      map<string, string> annotations = 8;

    • hasRestrictions

      boolean hasRestrictions()
       Key restrictions.
      .google.api.apikeys.v2.Restrictions restrictions = 9;
      Returns:
      Whether the restrictions field is set.

    • getRestrictions

      Restrictions getRestrictions()
       Key restrictions.
      .google.api.apikeys.v2.Restrictions restrictions = 9;
      Returns:
      The restrictions.

    • getRestrictionsOrBuilder

      RestrictionsOrBuilder getRestrictionsOrBuilder()
       Key restrictions.
      .google.api.apikeys.v2.Restrictions restrictions = 9;

    • getEtag

      String getEtag()
       Output only. A checksum computed by the server based on the current value
 of the Key resource. This may be sent on update and delete requests to
 ensure the client has an up-to-date value before proceeding. See
 https://google.aip.dev/154.
      string etag = 11 [(.google.api.field_behavior) = OUTPUT_ONLY];
      Returns:
      The etag.

    • getEtagBytes

      com.google.protobuf.ByteString getEtagBytes()
       Output only. A checksum computed by the server based on the current value
 of the Key resource. This may be sent on update and delete requests to
 ensure the client has an up-to-date value before proceeding. See
 https://google.aip.dev/154.
      string etag = 11 [(.google.api.field_behavior) = OUTPUT_ONLY];
      Returns:
      The bytes for etag.