Class GenerateIdTokenRequest.Builder

java.lang.Object
com.google.protobuf.AbstractMessageLite.Builder
com.google.protobuf.AbstractMessage.Builder<BuilderT>
com.google.protobuf.GeneratedMessage.Builder<GenerateIdTokenRequest.Builder>
com.google.cloud.iam.credentials.v1.GenerateIdTokenRequest.Builder
All Implemented Interfaces:
GenerateIdTokenRequestOrBuilder, com.google.protobuf.Message.Builder, com.google.protobuf.MessageLite.Builder, com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder, Cloneable
Enclosing class:
GenerateIdTokenRequest

public static final class GenerateIdTokenRequest.Builder extends com.google.protobuf.GeneratedMessage.Builder<GenerateIdTokenRequest.Builder> implements GenerateIdTokenRequestOrBuilder
Protobuf type google.iam.credentials.v1.GenerateIdTokenRequest
  • Method Details

    • getDescriptor

      public static final com.google.protobuf.Descriptors.Descriptor getDescriptor()
    • internalGetFieldAccessorTable

      protected com.google.protobuf.GeneratedMessage.FieldAccessorTable internalGetFieldAccessorTable()
      Specified by:
      internalGetFieldAccessorTable in class com.google.protobuf.GeneratedMessage.Builder<GenerateIdTokenRequest.Builder>
    • clear

      Specified by:
      clear in interface com.google.protobuf.Message.Builder
      Specified by:
      clear in interface com.google.protobuf.MessageLite.Builder
      Overrides:
      clear in class com.google.protobuf.GeneratedMessage.Builder<GenerateIdTokenRequest.Builder>
    • getDescriptorForType

      public com.google.protobuf.Descriptors.Descriptor getDescriptorForType()
      Specified by:
      getDescriptorForType in interface com.google.protobuf.Message.Builder
      Specified by:
      getDescriptorForType in interface com.google.protobuf.MessageOrBuilder
      Overrides:
      getDescriptorForType in class com.google.protobuf.GeneratedMessage.Builder<GenerateIdTokenRequest.Builder>
    • getDefaultInstanceForType

      public GenerateIdTokenRequest getDefaultInstanceForType()
      Specified by:
      getDefaultInstanceForType in interface com.google.protobuf.MessageLiteOrBuilder
      Specified by:
      getDefaultInstanceForType in interface com.google.protobuf.MessageOrBuilder
    • build

      public GenerateIdTokenRequest build()
      Specified by:
      build in interface com.google.protobuf.Message.Builder
      Specified by:
      build in interface com.google.protobuf.MessageLite.Builder
    • buildPartial

      public GenerateIdTokenRequest buildPartial()
      Specified by:
      buildPartial in interface com.google.protobuf.Message.Builder
      Specified by:
      buildPartial in interface com.google.protobuf.MessageLite.Builder
    • mergeFrom

      public GenerateIdTokenRequest.Builder mergeFrom(com.google.protobuf.Message other)
      Specified by:
      mergeFrom in interface com.google.protobuf.Message.Builder
      Overrides:
      mergeFrom in class com.google.protobuf.AbstractMessage.Builder<GenerateIdTokenRequest.Builder>
    • mergeFrom

    • isInitialized

      public final boolean isInitialized()
      Specified by:
      isInitialized in interface com.google.protobuf.MessageLiteOrBuilder
      Overrides:
      isInitialized in class com.google.protobuf.GeneratedMessage.Builder<GenerateIdTokenRequest.Builder>
    • mergeFrom

      public GenerateIdTokenRequest.Builder mergeFrom(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws IOException
      Specified by:
      mergeFrom in interface com.google.protobuf.Message.Builder
      Specified by:
      mergeFrom in interface com.google.protobuf.MessageLite.Builder
      Overrides:
      mergeFrom in class com.google.protobuf.AbstractMessage.Builder<GenerateIdTokenRequest.Builder>
      Throws:
      IOException
    • getName

      public String getName()
       Required. The resource name of the service account for which the credentials
       are requested, in the following format:
       `projects/-/serviceAccounts/{ACCOUNT_EMAIL_OR_UNIQUEID}`. The `-` wildcard
       character is required; replacing it with a project ID is invalid.
       
      string name = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { ... }
      Specified by:
      getName in interface GenerateIdTokenRequestOrBuilder
      Returns:
      The name.
    • getNameBytes

      public com.google.protobuf.ByteString getNameBytes()
       Required. The resource name of the service account for which the credentials
       are requested, in the following format:
       `projects/-/serviceAccounts/{ACCOUNT_EMAIL_OR_UNIQUEID}`. The `-` wildcard
       character is required; replacing it with a project ID is invalid.
       
      string name = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { ... }
      Specified by:
      getNameBytes in interface GenerateIdTokenRequestOrBuilder
      Returns:
      The bytes for name.
    • setName

      public GenerateIdTokenRequest.Builder setName(String value)
       Required. The resource name of the service account for which the credentials
       are requested, in the following format:
       `projects/-/serviceAccounts/{ACCOUNT_EMAIL_OR_UNIQUEID}`. The `-` wildcard
       character is required; replacing it with a project ID is invalid.
       
      string name = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { ... }
      Parameters:
      value - The name to set.
      Returns:
      This builder for chaining.
    • clearName

      public GenerateIdTokenRequest.Builder clearName()
       Required. The resource name of the service account for which the credentials
       are requested, in the following format:
       `projects/-/serviceAccounts/{ACCOUNT_EMAIL_OR_UNIQUEID}`. The `-` wildcard
       character is required; replacing it with a project ID is invalid.
       
      string name = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { ... }
      Returns:
      This builder for chaining.
    • setNameBytes

      public GenerateIdTokenRequest.Builder setNameBytes(com.google.protobuf.ByteString value)
       Required. The resource name of the service account for which the credentials
       are requested, in the following format:
       `projects/-/serviceAccounts/{ACCOUNT_EMAIL_OR_UNIQUEID}`. The `-` wildcard
       character is required; replacing it with a project ID is invalid.
       
      string name = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { ... }
      Parameters:
      value - The bytes for name to set.
      Returns:
      This builder for chaining.
    • getDelegatesList

      public com.google.protobuf.ProtocolStringList getDelegatesList()
       The sequence of service accounts in a delegation chain. Each service
       account must be granted the `roles/iam.serviceAccountTokenCreator` role
       on its next service account in the chain. The last service account in the
       chain must be granted the `roles/iam.serviceAccountTokenCreator` role
       on the service account that is specified in the `name` field of the
       request.
      
       The delegates must have the following format:
       `projects/-/serviceAccounts/{ACCOUNT_EMAIL_OR_UNIQUEID}`. The `-` wildcard
       character is required; replacing it with a project ID is invalid.
       
      repeated string delegates = 2;
      Specified by:
      getDelegatesList in interface GenerateIdTokenRequestOrBuilder
      Returns:
      A list containing the delegates.
    • getDelegatesCount

      public int getDelegatesCount()
       The sequence of service accounts in a delegation chain. Each service
       account must be granted the `roles/iam.serviceAccountTokenCreator` role
       on its next service account in the chain. The last service account in the
       chain must be granted the `roles/iam.serviceAccountTokenCreator` role
       on the service account that is specified in the `name` field of the
       request.
      
       The delegates must have the following format:
       `projects/-/serviceAccounts/{ACCOUNT_EMAIL_OR_UNIQUEID}`. The `-` wildcard
       character is required; replacing it with a project ID is invalid.
       
      repeated string delegates = 2;
      Specified by:
      getDelegatesCount in interface GenerateIdTokenRequestOrBuilder
      Returns:
      The count of delegates.
    • getDelegates

      public String getDelegates(int index)
       The sequence of service accounts in a delegation chain. Each service
       account must be granted the `roles/iam.serviceAccountTokenCreator` role
       on its next service account in the chain. The last service account in the
       chain must be granted the `roles/iam.serviceAccountTokenCreator` role
       on the service account that is specified in the `name` field of the
       request.
      
       The delegates must have the following format:
       `projects/-/serviceAccounts/{ACCOUNT_EMAIL_OR_UNIQUEID}`. The `-` wildcard
       character is required; replacing it with a project ID is invalid.
       
      repeated string delegates = 2;
      Specified by:
      getDelegates in interface GenerateIdTokenRequestOrBuilder
      Parameters:
      index - The index of the element to return.
      Returns:
      The delegates at the given index.
    • getDelegatesBytes

      public com.google.protobuf.ByteString getDelegatesBytes(int index)
       The sequence of service accounts in a delegation chain. Each service
       account must be granted the `roles/iam.serviceAccountTokenCreator` role
       on its next service account in the chain. The last service account in the
       chain must be granted the `roles/iam.serviceAccountTokenCreator` role
       on the service account that is specified in the `name` field of the
       request.
      
       The delegates must have the following format:
       `projects/-/serviceAccounts/{ACCOUNT_EMAIL_OR_UNIQUEID}`. The `-` wildcard
       character is required; replacing it with a project ID is invalid.
       
      repeated string delegates = 2;
      Specified by:
      getDelegatesBytes in interface GenerateIdTokenRequestOrBuilder
      Parameters:
      index - The index of the value to return.
      Returns:
      The bytes of the delegates at the given index.
    • setDelegates

      public GenerateIdTokenRequest.Builder setDelegates(int index, String value)
       The sequence of service accounts in a delegation chain. Each service
       account must be granted the `roles/iam.serviceAccountTokenCreator` role
       on its next service account in the chain. The last service account in the
       chain must be granted the `roles/iam.serviceAccountTokenCreator` role
       on the service account that is specified in the `name` field of the
       request.
      
       The delegates must have the following format:
       `projects/-/serviceAccounts/{ACCOUNT_EMAIL_OR_UNIQUEID}`. The `-` wildcard
       character is required; replacing it with a project ID is invalid.
       
      repeated string delegates = 2;
      Parameters:
      index - The index to set the value at.
      value - The delegates to set.
      Returns:
      This builder for chaining.
    • addDelegates

      public GenerateIdTokenRequest.Builder addDelegates(String value)
       The sequence of service accounts in a delegation chain. Each service
       account must be granted the `roles/iam.serviceAccountTokenCreator` role
       on its next service account in the chain. The last service account in the
       chain must be granted the `roles/iam.serviceAccountTokenCreator` role
       on the service account that is specified in the `name` field of the
       request.
      
       The delegates must have the following format:
       `projects/-/serviceAccounts/{ACCOUNT_EMAIL_OR_UNIQUEID}`. The `-` wildcard
       character is required; replacing it with a project ID is invalid.
       
      repeated string delegates = 2;
      Parameters:
      value - The delegates to add.
      Returns:
      This builder for chaining.
    • addAllDelegates

      public GenerateIdTokenRequest.Builder addAllDelegates(Iterable<String> values)
       The sequence of service accounts in a delegation chain. Each service
       account must be granted the `roles/iam.serviceAccountTokenCreator` role
       on its next service account in the chain. The last service account in the
       chain must be granted the `roles/iam.serviceAccountTokenCreator` role
       on the service account that is specified in the `name` field of the
       request.
      
       The delegates must have the following format:
       `projects/-/serviceAccounts/{ACCOUNT_EMAIL_OR_UNIQUEID}`. The `-` wildcard
       character is required; replacing it with a project ID is invalid.
       
      repeated string delegates = 2;
      Parameters:
      values - The delegates to add.
      Returns:
      This builder for chaining.
    • clearDelegates

      public GenerateIdTokenRequest.Builder clearDelegates()
       The sequence of service accounts in a delegation chain. Each service
       account must be granted the `roles/iam.serviceAccountTokenCreator` role
       on its next service account in the chain. The last service account in the
       chain must be granted the `roles/iam.serviceAccountTokenCreator` role
       on the service account that is specified in the `name` field of the
       request.
      
       The delegates must have the following format:
       `projects/-/serviceAccounts/{ACCOUNT_EMAIL_OR_UNIQUEID}`. The `-` wildcard
       character is required; replacing it with a project ID is invalid.
       
      repeated string delegates = 2;
      Returns:
      This builder for chaining.
    • addDelegatesBytes

      public GenerateIdTokenRequest.Builder addDelegatesBytes(com.google.protobuf.ByteString value)
       The sequence of service accounts in a delegation chain. Each service
       account must be granted the `roles/iam.serviceAccountTokenCreator` role
       on its next service account in the chain. The last service account in the
       chain must be granted the `roles/iam.serviceAccountTokenCreator` role
       on the service account that is specified in the `name` field of the
       request.
      
       The delegates must have the following format:
       `projects/-/serviceAccounts/{ACCOUNT_EMAIL_OR_UNIQUEID}`. The `-` wildcard
       character is required; replacing it with a project ID is invalid.
       
      repeated string delegates = 2;
      Parameters:
      value - The bytes of the delegates to add.
      Returns:
      This builder for chaining.
    • getAudience

      public String getAudience()
       Required. The audience for the token, such as the API or account that this token
       grants access to.
       
      string audience = 3 [(.google.api.field_behavior) = REQUIRED];
      Specified by:
      getAudience in interface GenerateIdTokenRequestOrBuilder
      Returns:
      The audience.
    • getAudienceBytes

      public com.google.protobuf.ByteString getAudienceBytes()
       Required. The audience for the token, such as the API or account that this token
       grants access to.
       
      string audience = 3 [(.google.api.field_behavior) = REQUIRED];
      Specified by:
      getAudienceBytes in interface GenerateIdTokenRequestOrBuilder
      Returns:
      The bytes for audience.
    • setAudience

      public GenerateIdTokenRequest.Builder setAudience(String value)
       Required. The audience for the token, such as the API or account that this token
       grants access to.
       
      string audience = 3 [(.google.api.field_behavior) = REQUIRED];
      Parameters:
      value - The audience to set.
      Returns:
      This builder for chaining.
    • clearAudience

      public GenerateIdTokenRequest.Builder clearAudience()
       Required. The audience for the token, such as the API or account that this token
       grants access to.
       
      string audience = 3 [(.google.api.field_behavior) = REQUIRED];
      Returns:
      This builder for chaining.
    • setAudienceBytes

      public GenerateIdTokenRequest.Builder setAudienceBytes(com.google.protobuf.ByteString value)
       Required. The audience for the token, such as the API or account that this token
       grants access to.
       
      string audience = 3 [(.google.api.field_behavior) = REQUIRED];
      Parameters:
      value - The bytes for audience to set.
      Returns:
      This builder for chaining.
    • getIncludeEmail

      public boolean getIncludeEmail()
       Include the service account email in the token. If set to `true`, the
       token will contain `email` and `email_verified` claims.
       
      bool include_email = 4;
      Specified by:
      getIncludeEmail in interface GenerateIdTokenRequestOrBuilder
      Returns:
      The includeEmail.
    • setIncludeEmail

      public GenerateIdTokenRequest.Builder setIncludeEmail(boolean value)
       Include the service account email in the token. If set to `true`, the
       token will contain `email` and `email_verified` claims.
       
      bool include_email = 4;
      Parameters:
      value - The includeEmail to set.
      Returns:
      This builder for chaining.
    • clearIncludeEmail

      public GenerateIdTokenRequest.Builder clearIncludeEmail()
       Include the service account email in the token. If set to `true`, the
       token will contain `email` and `email_verified` claims.
       
      bool include_email = 4;
      Returns:
      This builder for chaining.