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

      All Methods Instance Methods Abstract Methods 
      Modifier and Type Method Description
      java.lang.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.
      java.lang.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.
      java.lang.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.
      java.lang.String getOwnerType()
      The type of the owner to create the API key for.
      com.google.protobuf.ByteString getOwnerTypeBytes()
      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 Detail

      • getOwnerId

        java.lang.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.
      • getOwnerType

        java.lang.String getOwnerType()
         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.
         
        string owner_type = 2;
        Returns:
        The ownerType.
      • getOwnerTypeBytes

        com.google.protobuf.ByteString getOwnerTypeBytes()
         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.
         
        string owner_type = 2;
        Returns:
        The bytes for ownerType.
      • getDisplayName

        java.lang.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

        java.lang.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.