Interface ApiKeySpecOrBuilder

All Superinterfaces:
com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder
All Known Implementing Classes:
ApiKeySpec, ApiKeySpec.Builder
@Generated(value="protoc", comments="annotations:ApiKeySpecOrBuilder.java.pb.meta") public interface ApiKeySpecOrBuilder extends com.google.protobuf.MessageOrBuilder

  • Method Summary

    Modifier and Type
    Method
    Description
    String
    getDescription()
    The description of the API key.
    com.google.protobuf.ByteString
    getDescriptionBytes()
    The description of the API key.
    boolean
    getDisabled()
    True if the API key is disabled.
    String
    getDisplayName()
    The display name of the API key.
    com.google.protobuf.ByteString
    getDisplayNameBytes()
    The display name of the API key.
    com.google.protobuf.Timestamp
    getExpiryTime()
    The expiry time of the API key.
    com.google.protobuf.TimestampOrBuilder
    getExpiryTimeOrBuilder()
    The expiry time of the API key.
    String
    getOwnerId()
    The id of the owner to create the API key for.
    com.google.protobuf.ByteString
    getOwnerIdBytes()
    The id of the owner to create the API key for.
    OwnerType
    getOwnerType()
    The type of the owner to create the API key for.
    String
    getOwnerTypeDeprecated()
    Deprecated.
    temporal.api.cloud.identity.v1.ApiKeySpec.owner_type_deprecated is deprecated.
    com.google.protobuf.ByteString
    getOwnerTypeDeprecatedBytes()
    Deprecated.
    temporal.api.cloud.identity.v1.ApiKeySpec.owner_type_deprecated is deprecated.
    int
    getOwnerTypeValue()
    The type of the owner to create the API key for.
    boolean
    hasExpiryTime()
    The expiry time of the API key.

    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 Details

    • getOwnerId

      String getOwnerId()
       The id of the owner to create the API key for.
 The owner id is immutable. Once set during creation, it cannot be changed.
 The owner id is the id of the user when the owner type is user.
 The owner id is the id of the service account when the owner type is service account.
      string owner_id = 1;
      Returns:
      The ownerId.

    • getOwnerIdBytes

      com.google.protobuf.ByteString getOwnerIdBytes()
       The id of the owner to create the API key for.
 The owner id is immutable. Once set during creation, it cannot be changed.
 The owner id is the id of the user when the owner type is user.
 The owner id is the id of the service account when the owner type is service account.
      string owner_id = 1;
      Returns:
      The bytes for ownerId.

    • getOwnerTypeDeprecated

      @Deprecated String getOwnerTypeDeprecated()
      Deprecated.
      temporal.api.cloud.identity.v1.ApiKeySpec.owner_type_deprecated is deprecated. See temporal/api/cloud/identity/v1/message.proto;l=290
       The type of the owner to create the API key for.
 The owner type is immutable. Once set during creation, it cannot be changed.
 Possible values: user, service-account.
 Deprecated: Not supported after v0.3.0 api version. Use owner_type instead.
 temporal:versioning:max_version=v0.3.0
      string owner_type_deprecated = 2 [deprecated = true];
      Returns:
      The ownerTypeDeprecated.

    • getOwnerTypeDeprecatedBytes

      @Deprecated com.google.protobuf.ByteString getOwnerTypeDeprecatedBytes()
      Deprecated.
      temporal.api.cloud.identity.v1.ApiKeySpec.owner_type_deprecated is deprecated. See temporal/api/cloud/identity/v1/message.proto;l=290
       The type of the owner to create the API key for.
 The owner type is immutable. Once set during creation, it cannot be changed.
 Possible values: user, service-account.
 Deprecated: Not supported after v0.3.0 api version. Use owner_type instead.
 temporal:versioning:max_version=v0.3.0
      string owner_type_deprecated = 2 [deprecated = true];
      Returns:
      The bytes for ownerTypeDeprecated.

    • getOwnerTypeValue

      int getOwnerTypeValue()
       The type of the owner to create the API key for.
 temporal:versioning:min_version=v0.3.0
 temporal:enums:replaces=owner_type_deprecated
      .temporal.api.cloud.identity.v1.OwnerType owner_type = 7;
      Returns:
      The enum numeric value on the wire for ownerType.

    • getOwnerType

      OwnerType getOwnerType()
       The type of the owner to create the API key for.
 temporal:versioning:min_version=v0.3.0
 temporal:enums:replaces=owner_type_deprecated
      .temporal.api.cloud.identity.v1.OwnerType owner_type = 7;
      Returns:
      The ownerType.

    • getDisplayName

      String getDisplayName()
       The display name of the API key.
      string display_name = 3;
      Returns:
      The displayName.

    • getDisplayNameBytes

      com.google.protobuf.ByteString getDisplayNameBytes()
       The display name of the API key.
      string display_name = 3;
      Returns:
      The bytes for displayName.

    • getDescription

      String getDescription()
       The description of the API key.
      string description = 4;
      Returns:
      The description.

    • getDescriptionBytes

      com.google.protobuf.ByteString getDescriptionBytes()
       The description of the API key.
      string description = 4;
      Returns:
      The bytes for description.

    • hasExpiryTime

      boolean hasExpiryTime()
       The expiry time of the API key.
      .google.protobuf.Timestamp expiry_time = 5;
      Returns:
      Whether the expiryTime field is set.

    • getExpiryTime

      com.google.protobuf.Timestamp getExpiryTime()
       The expiry time of the API key.
      .google.protobuf.Timestamp expiry_time = 5;
      Returns:
      The expiryTime.

    • getExpiryTimeOrBuilder

      com.google.protobuf.TimestampOrBuilder getExpiryTimeOrBuilder()
       The expiry time of the API key.
      .google.protobuf.Timestamp expiry_time = 5;

    • getDisabled

      boolean getDisabled()
       True if the API key is disabled.
      bool disabled = 6;
      Returns:
      The disabled.