Package io.envoyproxy.envoy.extensions.common.aws.v3

Class AssumeRoleCredentialProvider.Builder

java.lang.Object
com.google.protobuf.AbstractMessageLite.Builder
com.google.protobuf.AbstractMessage.Builder<BuilderT>
com.google.protobuf.GeneratedMessageV3.Builder<AssumeRoleCredentialProvider.Builder>
io.envoyproxy.envoy.extensions.common.aws.v3.AssumeRoleCredentialProvider.Builder
All Implemented Interfaces:
com.google.protobuf.Message.Builder, com.google.protobuf.MessageLite.Builder, com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder, AssumeRoleCredentialProviderOrBuilder, Cloneable
Enclosing class:
AssumeRoleCredentialProvider
public static final class AssumeRoleCredentialProvider.Builder extends com.google.protobuf.GeneratedMessageV3.Builder<AssumeRoleCredentialProvider.Builder> implements AssumeRoleCredentialProviderOrBuilder
 Configuration to use `AssumeRole <https://docs.aws.amazon.com/STS/latest/APIReference/API_AssumeRole.html>`_ for retrieving new credentials, via role chaining.
 [#next-free-field: 6]
Protobuf type envoy.extensions.common.aws.v3.AssumeRoleCredentialProvider

  • Method Details

    • 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<AssumeRoleCredentialProvider.Builder>

    • clear

      public AssumeRoleCredentialProvider.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.GeneratedMessageV3.Builder<AssumeRoleCredentialProvider.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<AssumeRoleCredentialProvider.Builder>

    • getDefaultInstanceForType

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

    • build

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

    • buildPartial

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

    • clone

      public AssumeRoleCredentialProvider.Builder clone()
      Specified by:
      clone in interface com.google.protobuf.Message.Builder
      Specified by:
      clone in interface com.google.protobuf.MessageLite.Builder
      Overrides:
      clone in class com.google.protobuf.GeneratedMessageV3.Builder<AssumeRoleCredentialProvider.Builder>

    • setField

      public AssumeRoleCredentialProvider.Builder setField(com.google.protobuf.Descriptors.FieldDescriptor field, Object value)
      Specified by:
      setField in interface com.google.protobuf.Message.Builder
      Overrides:
      setField in class com.google.protobuf.GeneratedMessageV3.Builder<AssumeRoleCredentialProvider.Builder>

    • clearField

      public AssumeRoleCredentialProvider.Builder clearField(com.google.protobuf.Descriptors.FieldDescriptor field)
      Specified by:
      clearField in interface com.google.protobuf.Message.Builder
      Overrides:
      clearField in class com.google.protobuf.GeneratedMessageV3.Builder<AssumeRoleCredentialProvider.Builder>

    • clearOneof

      public AssumeRoleCredentialProvider.Builder clearOneof(com.google.protobuf.Descriptors.OneofDescriptor oneof)
      Specified by:
      clearOneof in interface com.google.protobuf.Message.Builder
      Overrides:
      clearOneof in class com.google.protobuf.GeneratedMessageV3.Builder<AssumeRoleCredentialProvider.Builder>

    • setRepeatedField

      public AssumeRoleCredentialProvider.Builder setRepeatedField(com.google.protobuf.Descriptors.FieldDescriptor field, int index, Object value)
      Specified by:
      setRepeatedField in interface com.google.protobuf.Message.Builder
      Overrides:
      setRepeatedField in class com.google.protobuf.GeneratedMessageV3.Builder<AssumeRoleCredentialProvider.Builder>

    • addRepeatedField

      public AssumeRoleCredentialProvider.Builder addRepeatedField(com.google.protobuf.Descriptors.FieldDescriptor field, Object value)
      Specified by:
      addRepeatedField in interface com.google.protobuf.Message.Builder
      Overrides:
      addRepeatedField in class com.google.protobuf.GeneratedMessageV3.Builder<AssumeRoleCredentialProvider.Builder>

    • mergeFrom

      public AssumeRoleCredentialProvider.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<AssumeRoleCredentialProvider.Builder>

    • mergeFrom

      public AssumeRoleCredentialProvider.Builder mergeFrom(AssumeRoleCredentialProvider other)

    • isInitialized

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

    • mergeFrom

      public AssumeRoleCredentialProvider.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<AssumeRoleCredentialProvider.Builder>
      Throws:
      IOException

    • getRoleArn

      public String getRoleArn()
       The ARN of the role to assume.
      string role_arn = 1 [(.validate.rules) = { ... }
      Specified by:
      getRoleArn in interface AssumeRoleCredentialProviderOrBuilder
      Returns:
      The roleArn.

    • getRoleArnBytes

      public com.google.protobuf.ByteString getRoleArnBytes()
       The ARN of the role to assume.
      string role_arn = 1 [(.validate.rules) = { ... }
      Specified by:
      getRoleArnBytes in interface AssumeRoleCredentialProviderOrBuilder
      Returns:
      The bytes for roleArn.

    • setRoleArn

      public AssumeRoleCredentialProvider.Builder setRoleArn(String value)
       The ARN of the role to assume.
      string role_arn = 1 [(.validate.rules) = { ... }
      Parameters:
      value - The roleArn to set.
      Returns:
      This builder for chaining.

    • clearRoleArn

      public AssumeRoleCredentialProvider.Builder clearRoleArn()
       The ARN of the role to assume.
      string role_arn = 1 [(.validate.rules) = { ... }
      Returns:
      This builder for chaining.

    • setRoleArnBytes

      public AssumeRoleCredentialProvider.Builder setRoleArnBytes(com.google.protobuf.ByteString value)
       The ARN of the role to assume.
      string role_arn = 1 [(.validate.rules) = { ... }
      Parameters:
      value - The bytes for roleArn to set.
      Returns:
      This builder for chaining.

    • getRoleSessionName

      public String getRoleSessionName()
       An optional role session name, used when identifying the role in subsequent AWS API calls. If not provided, the role session name will default
 to the current timestamp.
      string role_session_name = 2;
      Specified by:
      getRoleSessionName in interface AssumeRoleCredentialProviderOrBuilder
      Returns:
      The roleSessionName.

    • getRoleSessionNameBytes

      public com.google.protobuf.ByteString getRoleSessionNameBytes()
       An optional role session name, used when identifying the role in subsequent AWS API calls. If not provided, the role session name will default
 to the current timestamp.
      string role_session_name = 2;
      Specified by:
      getRoleSessionNameBytes in interface AssumeRoleCredentialProviderOrBuilder
      Returns:
      The bytes for roleSessionName.

    • setRoleSessionName

      public AssumeRoleCredentialProvider.Builder setRoleSessionName(String value)
       An optional role session name, used when identifying the role in subsequent AWS API calls. If not provided, the role session name will default
 to the current timestamp.
      string role_session_name = 2;
      Parameters:
      value - The roleSessionName to set.
      Returns:
      This builder for chaining.

    • clearRoleSessionName

      public AssumeRoleCredentialProvider.Builder clearRoleSessionName()
       An optional role session name, used when identifying the role in subsequent AWS API calls. If not provided, the role session name will default
 to the current timestamp.
      string role_session_name = 2;
      Returns:
      This builder for chaining.

    • setRoleSessionNameBytes

      public AssumeRoleCredentialProvider.Builder setRoleSessionNameBytes(com.google.protobuf.ByteString value)
       An optional role session name, used when identifying the role in subsequent AWS API calls. If not provided, the role session name will default
 to the current timestamp.
      string role_session_name = 2;
      Parameters:
      value - The bytes for roleSessionName to set.
      Returns:
      This builder for chaining.

    • getExternalId

      public String getExternalId()
       Optional string value to use as the externalId
      string external_id = 3;
      Specified by:
      getExternalId in interface AssumeRoleCredentialProviderOrBuilder
      Returns:
      The externalId.

    • getExternalIdBytes

      public com.google.protobuf.ByteString getExternalIdBytes()
       Optional string value to use as the externalId
      string external_id = 3;
      Specified by:
      getExternalIdBytes in interface AssumeRoleCredentialProviderOrBuilder
      Returns:
      The bytes for externalId.

    • setExternalId

      public AssumeRoleCredentialProvider.Builder setExternalId(String value)
       Optional string value to use as the externalId
      string external_id = 3;
      Parameters:
      value - The externalId to set.
      Returns:
      This builder for chaining.

    • clearExternalId

      public AssumeRoleCredentialProvider.Builder clearExternalId()
       Optional string value to use as the externalId
      string external_id = 3;
      Returns:
      This builder for chaining.

    • setExternalIdBytes

      public AssumeRoleCredentialProvider.Builder setExternalIdBytes(com.google.protobuf.ByteString value)
       Optional string value to use as the externalId
      string external_id = 3;
      Parameters:
      value - The bytes for externalId to set.
      Returns:
      This builder for chaining.

    • hasSessionDuration

      public boolean hasSessionDuration()
       An optional duration, in seconds, of the role session. Minimum role duration is 900s (5 minutes) and maximum is 43200s (12 hours).
 If the session duration is not provided, the default will be determined using the `table described here <https://docs.aws.amazon.com/IAM/latest/UserGuide/id_roles_manage-assume.html>`_.
      .google.protobuf.Duration session_duration = 4 [(.validate.rules) = { ... }
      Specified by:
      hasSessionDuration in interface AssumeRoleCredentialProviderOrBuilder
      Returns:
      Whether the sessionDuration field is set.

    • getSessionDuration

      public com.google.protobuf.Duration getSessionDuration()
       An optional duration, in seconds, of the role session. Minimum role duration is 900s (5 minutes) and maximum is 43200s (12 hours).
 If the session duration is not provided, the default will be determined using the `table described here <https://docs.aws.amazon.com/IAM/latest/UserGuide/id_roles_manage-assume.html>`_.
      .google.protobuf.Duration session_duration = 4 [(.validate.rules) = { ... }
      Specified by:
      getSessionDuration in interface AssumeRoleCredentialProviderOrBuilder
      Returns:
      The sessionDuration.

    • setSessionDuration

      public AssumeRoleCredentialProvider.Builder setSessionDuration(com.google.protobuf.Duration value)
       An optional duration, in seconds, of the role session. Minimum role duration is 900s (5 minutes) and maximum is 43200s (12 hours).
 If the session duration is not provided, the default will be determined using the `table described here <https://docs.aws.amazon.com/IAM/latest/UserGuide/id_roles_manage-assume.html>`_.
      .google.protobuf.Duration session_duration = 4 [(.validate.rules) = { ... }

    • setSessionDuration

      public AssumeRoleCredentialProvider.Builder setSessionDuration(com.google.protobuf.Duration.Builder builderForValue)
       An optional duration, in seconds, of the role session. Minimum role duration is 900s (5 minutes) and maximum is 43200s (12 hours).
 If the session duration is not provided, the default will be determined using the `table described here <https://docs.aws.amazon.com/IAM/latest/UserGuide/id_roles_manage-assume.html>`_.
      .google.protobuf.Duration session_duration = 4 [(.validate.rules) = { ... }

    • mergeSessionDuration

      public AssumeRoleCredentialProvider.Builder mergeSessionDuration(com.google.protobuf.Duration value)
       An optional duration, in seconds, of the role session. Minimum role duration is 900s (5 minutes) and maximum is 43200s (12 hours).
 If the session duration is not provided, the default will be determined using the `table described here <https://docs.aws.amazon.com/IAM/latest/UserGuide/id_roles_manage-assume.html>`_.
      .google.protobuf.Duration session_duration = 4 [(.validate.rules) = { ... }

    • clearSessionDuration

      public AssumeRoleCredentialProvider.Builder clearSessionDuration()
       An optional duration, in seconds, of the role session. Minimum role duration is 900s (5 minutes) and maximum is 43200s (12 hours).
 If the session duration is not provided, the default will be determined using the `table described here <https://docs.aws.amazon.com/IAM/latest/UserGuide/id_roles_manage-assume.html>`_.
      .google.protobuf.Duration session_duration = 4 [(.validate.rules) = { ... }

    • getSessionDurationBuilder

      public com.google.protobuf.Duration.Builder getSessionDurationBuilder()
       An optional duration, in seconds, of the role session. Minimum role duration is 900s (5 minutes) and maximum is 43200s (12 hours).
 If the session duration is not provided, the default will be determined using the `table described here <https://docs.aws.amazon.com/IAM/latest/UserGuide/id_roles_manage-assume.html>`_.
      .google.protobuf.Duration session_duration = 4 [(.validate.rules) = { ... }

    • getSessionDurationOrBuilder

      public com.google.protobuf.DurationOrBuilder getSessionDurationOrBuilder()
       An optional duration, in seconds, of the role session. Minimum role duration is 900s (5 minutes) and maximum is 43200s (12 hours).
 If the session duration is not provided, the default will be determined using the `table described here <https://docs.aws.amazon.com/IAM/latest/UserGuide/id_roles_manage-assume.html>`_.
      .google.protobuf.Duration session_duration = 4 [(.validate.rules) = { ... }
      Specified by:
      getSessionDurationOrBuilder in interface AssumeRoleCredentialProviderOrBuilder

    • hasCredentialProvider

      public boolean hasCredentialProvider()
       The credential provider for signing the AssumeRole request. This is optional and if not set,
 it will be retrieved from the procedure described in :ref:`config_http_filters_aws_request_signing`.
 This list of credential providers cannot include an AssumeRole credential provider and if one is provided
 it will be ignored.
      .envoy.extensions.common.aws.v3.AwsCredentialProvider credential_provider = 5;
      Specified by:
      hasCredentialProvider in interface AssumeRoleCredentialProviderOrBuilder
      Returns:
      Whether the credentialProvider field is set.

    • getCredentialProvider

      public AwsCredentialProvider getCredentialProvider()
       The credential provider for signing the AssumeRole request. This is optional and if not set,
 it will be retrieved from the procedure described in :ref:`config_http_filters_aws_request_signing`.
 This list of credential providers cannot include an AssumeRole credential provider and if one is provided
 it will be ignored.
      .envoy.extensions.common.aws.v3.AwsCredentialProvider credential_provider = 5;
      Specified by:
      getCredentialProvider in interface AssumeRoleCredentialProviderOrBuilder
      Returns:
      The credentialProvider.

    • setCredentialProvider

      public AssumeRoleCredentialProvider.Builder setCredentialProvider(AwsCredentialProvider value)
       The credential provider for signing the AssumeRole request. This is optional and if not set,
 it will be retrieved from the procedure described in :ref:`config_http_filters_aws_request_signing`.
 This list of credential providers cannot include an AssumeRole credential provider and if one is provided
 it will be ignored.
      .envoy.extensions.common.aws.v3.AwsCredentialProvider credential_provider = 5;

    • setCredentialProvider

      public AssumeRoleCredentialProvider.Builder setCredentialProvider(AwsCredentialProvider.Builder builderForValue)
       The credential provider for signing the AssumeRole request. This is optional and if not set,
 it will be retrieved from the procedure described in :ref:`config_http_filters_aws_request_signing`.
 This list of credential providers cannot include an AssumeRole credential provider and if one is provided
 it will be ignored.
      .envoy.extensions.common.aws.v3.AwsCredentialProvider credential_provider = 5;

    • mergeCredentialProvider

      public AssumeRoleCredentialProvider.Builder mergeCredentialProvider(AwsCredentialProvider value)
       The credential provider for signing the AssumeRole request. This is optional and if not set,
 it will be retrieved from the procedure described in :ref:`config_http_filters_aws_request_signing`.
 This list of credential providers cannot include an AssumeRole credential provider and if one is provided
 it will be ignored.
      .envoy.extensions.common.aws.v3.AwsCredentialProvider credential_provider = 5;

    • clearCredentialProvider

      public AssumeRoleCredentialProvider.Builder clearCredentialProvider()
       The credential provider for signing the AssumeRole request. This is optional and if not set,
 it will be retrieved from the procedure described in :ref:`config_http_filters_aws_request_signing`.
 This list of credential providers cannot include an AssumeRole credential provider and if one is provided
 it will be ignored.
      .envoy.extensions.common.aws.v3.AwsCredentialProvider credential_provider = 5;

    • getCredentialProviderBuilder

      public AwsCredentialProvider.Builder getCredentialProviderBuilder()
       The credential provider for signing the AssumeRole request. This is optional and if not set,
 it will be retrieved from the procedure described in :ref:`config_http_filters_aws_request_signing`.
 This list of credential providers cannot include an AssumeRole credential provider and if one is provided
 it will be ignored.
      .envoy.extensions.common.aws.v3.AwsCredentialProvider credential_provider = 5;

    • getCredentialProviderOrBuilder

      public AwsCredentialProviderOrBuilder getCredentialProviderOrBuilder()
       The credential provider for signing the AssumeRole request. This is optional and if not set,
 it will be retrieved from the procedure described in :ref:`config_http_filters_aws_request_signing`.
 This list of credential providers cannot include an AssumeRole credential provider and if one is provided
 it will be ignored.
      .envoy.extensions.common.aws.v3.AwsCredentialProvider credential_provider = 5;
      Specified by:
      getCredentialProviderOrBuilder in interface AssumeRoleCredentialProviderOrBuilder

    • setUnknownFields

      public final AssumeRoleCredentialProvider.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<AssumeRoleCredentialProvider.Builder>

    • mergeUnknownFields

      public final AssumeRoleCredentialProvider.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<AssumeRoleCredentialProvider.Builder>