Class AssumeRoleWithWebIdentityCredentialProvider.Builder

java.lang.Object
com.google.protobuf.AbstractMessageLite.Builder
com.google.protobuf.AbstractMessage.Builder<BuilderT>
com.google.protobuf.GeneratedMessageV3.Builder<AssumeRoleWithWebIdentityCredentialProvider.Builder>
io.envoyproxy.envoy.extensions.common.aws.v3.AssumeRoleWithWebIdentityCredentialProvider.Builder
All Implemented Interfaces:
com.google.protobuf.Message.Builder, com.google.protobuf.MessageLite.Builder, com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder, AssumeRoleWithWebIdentityCredentialProviderOrBuilder, Cloneable
Enclosing class:
AssumeRoleWithWebIdentityCredentialProvider

public static final class AssumeRoleWithWebIdentityCredentialProvider.Builder extends com.google.protobuf.GeneratedMessageV3.Builder<AssumeRoleWithWebIdentityCredentialProvider.Builder> implements AssumeRoleWithWebIdentityCredentialProviderOrBuilder
 Configuration to use `AssumeRoleWithWebIdentity <https://docs.aws.amazon.com/STS/latest/APIReference/API_AssumeRoleWithWebIdentity.html>`_
 to retrieve AWS credentials.
 
Protobuf type envoy.extensions.common.aws.v3.AssumeRoleWithWebIdentityCredentialProvider
  • 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<AssumeRoleWithWebIdentityCredentialProvider.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<AssumeRoleWithWebIdentityCredentialProvider.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<AssumeRoleWithWebIdentityCredentialProvider.Builder>
    • getDefaultInstanceForType

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

      Specified by:
      build in interface com.google.protobuf.Message.Builder
      Specified by:
      build in interface com.google.protobuf.MessageLite.Builder
    • buildPartial

      Specified by:
      buildPartial in interface com.google.protobuf.Message.Builder
      Specified by:
      buildPartial in interface com.google.protobuf.MessageLite.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<AssumeRoleWithWebIdentityCredentialProvider.Builder>
    • setField

      public AssumeRoleWithWebIdentityCredentialProvider.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<AssumeRoleWithWebIdentityCredentialProvider.Builder>
    • clearField

      public AssumeRoleWithWebIdentityCredentialProvider.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<AssumeRoleWithWebIdentityCredentialProvider.Builder>
    • clearOneof

      public AssumeRoleWithWebIdentityCredentialProvider.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<AssumeRoleWithWebIdentityCredentialProvider.Builder>
    • setRepeatedField

      public AssumeRoleWithWebIdentityCredentialProvider.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<AssumeRoleWithWebIdentityCredentialProvider.Builder>
    • addRepeatedField

      public AssumeRoleWithWebIdentityCredentialProvider.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<AssumeRoleWithWebIdentityCredentialProvider.Builder>
    • mergeFrom

      public AssumeRoleWithWebIdentityCredentialProvider.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<AssumeRoleWithWebIdentityCredentialProvider.Builder>
    • mergeFrom

    • isInitialized

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

      public AssumeRoleWithWebIdentityCredentialProvider.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<AssumeRoleWithWebIdentityCredentialProvider.Builder>
      Throws:
      IOException
    • hasWebIdentityTokenDataSource

      public boolean hasWebIdentityTokenDataSource()
       Data source for a web identity token that is provided by the identity provider to assume the role.
       If a ``watched_directory`` is not provided, one will be automatically inferred from the directory of the token file. This is to ensure
       that if the token file is rotated, the new token will be picked up. This behaviour differs from the standard envoy data source behavior, which does not
       automatically watch the directory of a file data source.
       Even when file rotation occurs, current credentials will continue to be used until they expire, at which point new credentials will be retrieved using the new token.
       
      .envoy.config.core.v3.DataSource web_identity_token_data_source = 1 [(.udpa.annotations.sensitive) = true];
      Specified by:
      hasWebIdentityTokenDataSource in interface AssumeRoleWithWebIdentityCredentialProviderOrBuilder
      Returns:
      Whether the webIdentityTokenDataSource field is set.
    • getWebIdentityTokenDataSource

      public DataSource getWebIdentityTokenDataSource()
       Data source for a web identity token that is provided by the identity provider to assume the role.
       If a ``watched_directory`` is not provided, one will be automatically inferred from the directory of the token file. This is to ensure
       that if the token file is rotated, the new token will be picked up. This behaviour differs from the standard envoy data source behavior, which does not
       automatically watch the directory of a file data source.
       Even when file rotation occurs, current credentials will continue to be used until they expire, at which point new credentials will be retrieved using the new token.
       
      .envoy.config.core.v3.DataSource web_identity_token_data_source = 1 [(.udpa.annotations.sensitive) = true];
      Specified by:
      getWebIdentityTokenDataSource in interface AssumeRoleWithWebIdentityCredentialProviderOrBuilder
      Returns:
      The webIdentityTokenDataSource.
    • setWebIdentityTokenDataSource

      public AssumeRoleWithWebIdentityCredentialProvider.Builder setWebIdentityTokenDataSource(DataSource value)
       Data source for a web identity token that is provided by the identity provider to assume the role.
       If a ``watched_directory`` is not provided, one will be automatically inferred from the directory of the token file. This is to ensure
       that if the token file is rotated, the new token will be picked up. This behaviour differs from the standard envoy data source behavior, which does not
       automatically watch the directory of a file data source.
       Even when file rotation occurs, current credentials will continue to be used until they expire, at which point new credentials will be retrieved using the new token.
       
      .envoy.config.core.v3.DataSource web_identity_token_data_source = 1 [(.udpa.annotations.sensitive) = true];
    • setWebIdentityTokenDataSource

      public AssumeRoleWithWebIdentityCredentialProvider.Builder setWebIdentityTokenDataSource(DataSource.Builder builderForValue)
       Data source for a web identity token that is provided by the identity provider to assume the role.
       If a ``watched_directory`` is not provided, one will be automatically inferred from the directory of the token file. This is to ensure
       that if the token file is rotated, the new token will be picked up. This behaviour differs from the standard envoy data source behavior, which does not
       automatically watch the directory of a file data source.
       Even when file rotation occurs, current credentials will continue to be used until they expire, at which point new credentials will be retrieved using the new token.
       
      .envoy.config.core.v3.DataSource web_identity_token_data_source = 1 [(.udpa.annotations.sensitive) = true];
    • mergeWebIdentityTokenDataSource

      public AssumeRoleWithWebIdentityCredentialProvider.Builder mergeWebIdentityTokenDataSource(DataSource value)
       Data source for a web identity token that is provided by the identity provider to assume the role.
       If a ``watched_directory`` is not provided, one will be automatically inferred from the directory of the token file. This is to ensure
       that if the token file is rotated, the new token will be picked up. This behaviour differs from the standard envoy data source behavior, which does not
       automatically watch the directory of a file data source.
       Even when file rotation occurs, current credentials will continue to be used until they expire, at which point new credentials will be retrieved using the new token.
       
      .envoy.config.core.v3.DataSource web_identity_token_data_source = 1 [(.udpa.annotations.sensitive) = true];
    • clearWebIdentityTokenDataSource

      public AssumeRoleWithWebIdentityCredentialProvider.Builder clearWebIdentityTokenDataSource()
       Data source for a web identity token that is provided by the identity provider to assume the role.
       If a ``watched_directory`` is not provided, one will be automatically inferred from the directory of the token file. This is to ensure
       that if the token file is rotated, the new token will be picked up. This behaviour differs from the standard envoy data source behavior, which does not
       automatically watch the directory of a file data source.
       Even when file rotation occurs, current credentials will continue to be used until they expire, at which point new credentials will be retrieved using the new token.
       
      .envoy.config.core.v3.DataSource web_identity_token_data_source = 1 [(.udpa.annotations.sensitive) = true];
    • getWebIdentityTokenDataSourceBuilder

      public DataSource.Builder getWebIdentityTokenDataSourceBuilder()
       Data source for a web identity token that is provided by the identity provider to assume the role.
       If a ``watched_directory`` is not provided, one will be automatically inferred from the directory of the token file. This is to ensure
       that if the token file is rotated, the new token will be picked up. This behaviour differs from the standard envoy data source behavior, which does not
       automatically watch the directory of a file data source.
       Even when file rotation occurs, current credentials will continue to be used until they expire, at which point new credentials will be retrieved using the new token.
       
      .envoy.config.core.v3.DataSource web_identity_token_data_source = 1 [(.udpa.annotations.sensitive) = true];
    • getWebIdentityTokenDataSourceOrBuilder

      public DataSourceOrBuilder getWebIdentityTokenDataSourceOrBuilder()
       Data source for a web identity token that is provided by the identity provider to assume the role.
       If a ``watched_directory`` is not provided, one will be automatically inferred from the directory of the token file. This is to ensure
       that if the token file is rotated, the new token will be picked up. This behaviour differs from the standard envoy data source behavior, which does not
       automatically watch the directory of a file data source.
       Even when file rotation occurs, current credentials will continue to be used until they expire, at which point new credentials will be retrieved using the new token.
       
      .envoy.config.core.v3.DataSource web_identity_token_data_source = 1 [(.udpa.annotations.sensitive) = true];
      Specified by:
      getWebIdentityTokenDataSourceOrBuilder in interface AssumeRoleWithWebIdentityCredentialProviderOrBuilder
    • getRoleArn

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

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

       The ARN of the role to assume.
       
      string role_arn = 2 [(.validate.rules) = { ... }
      Parameters:
      value - The roleArn to set.
      Returns:
      This builder for chaining.
    • clearRoleArn

       The ARN of the role to assume.
       
      string role_arn = 2 [(.validate.rules) = { ... }
      Returns:
      This builder for chaining.
    • setRoleArnBytes

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

      public String getRoleSessionName()
       Optional role session name to use in AssumeRoleWithWebIdentity API call.
       
      string role_session_name = 3;
      Specified by:
      getRoleSessionName in interface AssumeRoleWithWebIdentityCredentialProviderOrBuilder
      Returns:
      The roleSessionName.
    • getRoleSessionNameBytes

      public com.google.protobuf.ByteString getRoleSessionNameBytes()
       Optional role session name to use in AssumeRoleWithWebIdentity API call.
       
      string role_session_name = 3;
      Specified by:
      getRoleSessionNameBytes in interface AssumeRoleWithWebIdentityCredentialProviderOrBuilder
      Returns:
      The bytes for roleSessionName.
    • setRoleSessionName

       Optional role session name to use in AssumeRoleWithWebIdentity API call.
       
      string role_session_name = 3;
      Parameters:
      value - The roleSessionName to set.
      Returns:
      This builder for chaining.
    • clearRoleSessionName

       Optional role session name to use in AssumeRoleWithWebIdentity API call.
       
      string role_session_name = 3;
      Returns:
      This builder for chaining.
    • setRoleSessionNameBytes

      public AssumeRoleWithWebIdentityCredentialProvider.Builder setRoleSessionNameBytes(com.google.protobuf.ByteString value)
       Optional role session name to use in AssumeRoleWithWebIdentity API call.
       
      string role_session_name = 3;
      Parameters:
      value - The bytes for roleSessionName to set.
      Returns:
      This builder for chaining.
    • setUnknownFields

      public final AssumeRoleWithWebIdentityCredentialProvider.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<AssumeRoleWithWebIdentityCredentialProvider.Builder>
    • mergeUnknownFields

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