Package com.google.cloud.iam.credentials.v1

Class GenerateAccessTokenRequest.Builder

    • Method Detail

      • getDescriptor

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

      • internalGetFieldAccessorTable

        protected com.google.protobuf.GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
        Specified by:
        internalGetFieldAccessorTable in class com.google.protobuf.GeneratedMessageV3.Builder<GenerateAccessTokenRequest.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.GeneratedMessageV3.Builder<GenerateAccessTokenRequest.Builder>

      • getDefaultInstanceForType

        public GenerateAccessTokenRequest getDefaultInstanceForType()
        Specified by:
        getDefaultInstanceForType in interface com.google.protobuf.MessageLiteOrBuilder
        Specified by:
        getDefaultInstanceForType in interface com.google.protobuf.MessageOrBuilder

      • build

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

      • buildPartial

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

      • isInitialized

        public final boolean isInitialized()
        Specified by:
        isInitialized in interface com.google.protobuf.MessageLiteOrBuilder
        Overrides:
        isInitialized in class com.google.protobuf.GeneratedMessageV3.Builder<GenerateAccessTokenRequest.Builder>

      • mergeFrom

        public GenerateAccessTokenRequest.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<GenerateAccessTokenRequest.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 GenerateAccessTokenRequestOrBuilder
        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 GenerateAccessTokenRequestOrBuilder
        Returns:
        The bytes for name.

      • setName

        public GenerateAccessTokenRequest.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 GenerateAccessTokenRequest.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 GenerateAccessTokenRequest.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 GenerateAccessTokenRequestOrBuilder
        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 GenerateAccessTokenRequestOrBuilder
        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 GenerateAccessTokenRequestOrBuilder
        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 GenerateAccessTokenRequestOrBuilder
        Parameters:
        index - The index of the value to return.
        Returns:
        The bytes of the delegates at the given index.

      • setDelegates

        public GenerateAccessTokenRequest.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 GenerateAccessTokenRequest.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 GenerateAccessTokenRequest.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 GenerateAccessTokenRequest.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 GenerateAccessTokenRequest.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.

      • getScopeList

        public com.google.protobuf.ProtocolStringList getScopeList()
         Required. Code to identify the scopes to be included in the OAuth 2.0 access token.
 See https://developers.google.com/identity/protocols/googlescopes for more
 information.
 At least one value required.
        repeated string scope = 4 [(.google.api.field_behavior) = REQUIRED];
        Specified by:
        getScopeList in interface GenerateAccessTokenRequestOrBuilder
        Returns:
        A list containing the scope.

      • getScopeCount

        public int getScopeCount()
         Required. Code to identify the scopes to be included in the OAuth 2.0 access token.
 See https://developers.google.com/identity/protocols/googlescopes for more
 information.
 At least one value required.
        repeated string scope = 4 [(.google.api.field_behavior) = REQUIRED];
        Specified by:
        getScopeCount in interface GenerateAccessTokenRequestOrBuilder
        Returns:
        The count of scope.

      • getScope

        public String getScope​(int index)
         Required. Code to identify the scopes to be included in the OAuth 2.0 access token.
 See https://developers.google.com/identity/protocols/googlescopes for more
 information.
 At least one value required.
        repeated string scope = 4 [(.google.api.field_behavior) = REQUIRED];
        Specified by:
        getScope in interface GenerateAccessTokenRequestOrBuilder
        Parameters:
        index - The index of the element to return.
        Returns:
        The scope at the given index.

      • getScopeBytes

        public com.google.protobuf.ByteString getScopeBytes​(int index)
         Required. Code to identify the scopes to be included in the OAuth 2.0 access token.
 See https://developers.google.com/identity/protocols/googlescopes for more
 information.
 At least one value required.
        repeated string scope = 4 [(.google.api.field_behavior) = REQUIRED];
        Specified by:
        getScopeBytes in interface GenerateAccessTokenRequestOrBuilder
        Parameters:
        index - The index of the value to return.
        Returns:
        The bytes of the scope at the given index.

      • setScope

        public GenerateAccessTokenRequest.Builder setScope​(int index,
                                                   String value)
         Required. Code to identify the scopes to be included in the OAuth 2.0 access token.
 See https://developers.google.com/identity/protocols/googlescopes for more
 information.
 At least one value required.
        repeated string scope = 4 [(.google.api.field_behavior) = REQUIRED];
        Parameters:
        index - The index to set the value at.
        value - The scope to set.
        Returns:
        This builder for chaining.

      • addScope

        public GenerateAccessTokenRequest.Builder addScope​(String value)
         Required. Code to identify the scopes to be included in the OAuth 2.0 access token.
 See https://developers.google.com/identity/protocols/googlescopes for more
 information.
 At least one value required.
        repeated string scope = 4 [(.google.api.field_behavior) = REQUIRED];
        Parameters:
        value - The scope to add.
        Returns:
        This builder for chaining.

      • addAllScope

        public GenerateAccessTokenRequest.Builder addAllScope​(Iterable<String> values)
         Required. Code to identify the scopes to be included in the OAuth 2.0 access token.
 See https://developers.google.com/identity/protocols/googlescopes for more
 information.
 At least one value required.
        repeated string scope = 4 [(.google.api.field_behavior) = REQUIRED];
        Parameters:
        values - The scope to add.
        Returns:
        This builder for chaining.

      • clearScope

        public GenerateAccessTokenRequest.Builder clearScope()
         Required. Code to identify the scopes to be included in the OAuth 2.0 access token.
 See https://developers.google.com/identity/protocols/googlescopes for more
 information.
 At least one value required.
        repeated string scope = 4 [(.google.api.field_behavior) = REQUIRED];
        Returns:
        This builder for chaining.

      • addScopeBytes

        public GenerateAccessTokenRequest.Builder addScopeBytes​(com.google.protobuf.ByteString value)
         Required. Code to identify the scopes to be included in the OAuth 2.0 access token.
 See https://developers.google.com/identity/protocols/googlescopes for more
 information.
 At least one value required.
        repeated string scope = 4 [(.google.api.field_behavior) = REQUIRED];
        Parameters:
        value - The bytes of the scope to add.
        Returns:
        This builder for chaining.

      • hasLifetime

        public boolean hasLifetime()
         The desired lifetime duration of the access token in seconds.
 Must be set to a value less than or equal to 3600 (1 hour). If a value is
 not specified, the token's lifetime will be set to a default value of one
 hour.
        .google.protobuf.Duration lifetime = 7;
        Specified by:
        hasLifetime in interface GenerateAccessTokenRequestOrBuilder
        Returns:
        Whether the lifetime field is set.

      • getLifetime

        public com.google.protobuf.Duration getLifetime()
         The desired lifetime duration of the access token in seconds.
 Must be set to a value less than or equal to 3600 (1 hour). If a value is
 not specified, the token's lifetime will be set to a default value of one
 hour.
        .google.protobuf.Duration lifetime = 7;
        Specified by:
        getLifetime in interface GenerateAccessTokenRequestOrBuilder
        Returns:
        The lifetime.

      • setLifetime

        public GenerateAccessTokenRequest.Builder setLifetime​(com.google.protobuf.Duration value)
         The desired lifetime duration of the access token in seconds.
 Must be set to a value less than or equal to 3600 (1 hour). If a value is
 not specified, the token's lifetime will be set to a default value of one
 hour.
        .google.protobuf.Duration lifetime = 7;

      • setLifetime

        public GenerateAccessTokenRequest.Builder setLifetime​(com.google.protobuf.Duration.Builder builderForValue)
         The desired lifetime duration of the access token in seconds.
 Must be set to a value less than or equal to 3600 (1 hour). If a value is
 not specified, the token's lifetime will be set to a default value of one
 hour.
        .google.protobuf.Duration lifetime = 7;

      • mergeLifetime

        public GenerateAccessTokenRequest.Builder mergeLifetime​(com.google.protobuf.Duration value)
         The desired lifetime duration of the access token in seconds.
 Must be set to a value less than or equal to 3600 (1 hour). If a value is
 not specified, the token's lifetime will be set to a default value of one
 hour.
        .google.protobuf.Duration lifetime = 7;

      • clearLifetime

        public GenerateAccessTokenRequest.Builder clearLifetime()
         The desired lifetime duration of the access token in seconds.
 Must be set to a value less than or equal to 3600 (1 hour). If a value is
 not specified, the token's lifetime will be set to a default value of one
 hour.
        .google.protobuf.Duration lifetime = 7;

      • getLifetimeBuilder

        public com.google.protobuf.Duration.Builder getLifetimeBuilder()
         The desired lifetime duration of the access token in seconds.
 Must be set to a value less than or equal to 3600 (1 hour). If a value is
 not specified, the token's lifetime will be set to a default value of one
 hour.
        .google.protobuf.Duration lifetime = 7;

      • getLifetimeOrBuilder

        public com.google.protobuf.DurationOrBuilder getLifetimeOrBuilder()
         The desired lifetime duration of the access token in seconds.
 Must be set to a value less than or equal to 3600 (1 hour). If a value is
 not specified, the token's lifetime will be set to a default value of one
 hour.
        .google.protobuf.Duration lifetime = 7;
        Specified by:
        getLifetimeOrBuilder in interface GenerateAccessTokenRequestOrBuilder

      • setUnknownFields

        public final GenerateAccessTokenRequest.Builder setUnknownFields​(com.google.protobuf.UnknownFieldSet unknownFields)
        Specified by:
        setUnknownFields in interface com.google.protobuf.Message.Builder
        Overrides:
        setUnknownFields in class com.google.protobuf.GeneratedMessageV3.Builder<GenerateAccessTokenRequest.Builder>

      • mergeUnknownFields

        public final GenerateAccessTokenRequest.Builder mergeUnknownFields​(com.google.protobuf.UnknownFieldSet unknownFields)
        Specified by:
        mergeUnknownFields in interface com.google.protobuf.Message.Builder
        Overrides:
        mergeUnknownFields in class com.google.protobuf.GeneratedMessageV3.Builder<GenerateAccessTokenRequest.Builder>