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

Class AwsCredentialProvider.Builder

java.lang.Object
com.google.protobuf.AbstractMessageLite.Builder
com.google.protobuf.AbstractMessage.Builder<BuilderT>
com.google.protobuf.GeneratedMessageV3.Builder<AwsCredentialProvider.Builder>
io.envoyproxy.envoy.extensions.common.aws.v3.AwsCredentialProvider.Builder
All Implemented Interfaces:
com.google.protobuf.Message.Builder, com.google.protobuf.MessageLite.Builder, com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder, AwsCredentialProviderOrBuilder, Cloneable
Enclosing class:
AwsCredentialProvider
public static final class AwsCredentialProvider.Builder extends com.google.protobuf.GeneratedMessageV3.Builder<AwsCredentialProvider.Builder> implements AwsCredentialProviderOrBuilder
 Configuration for AWS credential provider. This is optional and the credentials are normally
 retrieved from the environment or AWS configuration files by following the default credential
 provider chain. However, this configuration can be used to override the default behavior.
Protobuf type envoy.extensions.common.aws.v3.AwsCredentialProvider

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

    • clear

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

    • getDefaultInstanceForType

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

    • build

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

    • buildPartial

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

    • clone

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

    • setField

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

    • clearField

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

    • clearOneof

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

    • setRepeatedField

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

    • addRepeatedField

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

    • mergeFrom

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

    • mergeFrom

      public AwsCredentialProvider.Builder mergeFrom(AwsCredentialProvider other)

    • isInitialized

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

    • mergeFrom

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

    • hasAssumeRoleWithWebIdentityProvider

      public boolean hasAssumeRoleWithWebIdentityProvider()
       The option to use `AssumeRoleWithWebIdentity <https://docs.aws.amazon.com/STS/latest/APIReference/API_AssumeRoleWithWebIdentity.html>`_.
      .envoy.extensions.common.aws.v3.AssumeRoleWithWebIdentityCredentialProvider assume_role_with_web_identity_provider = 1;
      Specified by:
      hasAssumeRoleWithWebIdentityProvider in interface AwsCredentialProviderOrBuilder
      Returns:
      Whether the assumeRoleWithWebIdentityProvider field is set.

    • getAssumeRoleWithWebIdentityProvider

      public AssumeRoleWithWebIdentityCredentialProvider getAssumeRoleWithWebIdentityProvider()
       The option to use `AssumeRoleWithWebIdentity <https://docs.aws.amazon.com/STS/latest/APIReference/API_AssumeRoleWithWebIdentity.html>`_.
      .envoy.extensions.common.aws.v3.AssumeRoleWithWebIdentityCredentialProvider assume_role_with_web_identity_provider = 1;
      Specified by:
      getAssumeRoleWithWebIdentityProvider in interface AwsCredentialProviderOrBuilder
      Returns:
      The assumeRoleWithWebIdentityProvider.

    • setAssumeRoleWithWebIdentityProvider

      public AwsCredentialProvider.Builder setAssumeRoleWithWebIdentityProvider(AssumeRoleWithWebIdentityCredentialProvider value)
       The option to use `AssumeRoleWithWebIdentity <https://docs.aws.amazon.com/STS/latest/APIReference/API_AssumeRoleWithWebIdentity.html>`_.
      .envoy.extensions.common.aws.v3.AssumeRoleWithWebIdentityCredentialProvider assume_role_with_web_identity_provider = 1;

    • setAssumeRoleWithWebIdentityProvider

      public AwsCredentialProvider.Builder setAssumeRoleWithWebIdentityProvider(AssumeRoleWithWebIdentityCredentialProvider.Builder builderForValue)
       The option to use `AssumeRoleWithWebIdentity <https://docs.aws.amazon.com/STS/latest/APIReference/API_AssumeRoleWithWebIdentity.html>`_.
      .envoy.extensions.common.aws.v3.AssumeRoleWithWebIdentityCredentialProvider assume_role_with_web_identity_provider = 1;

    • mergeAssumeRoleWithWebIdentityProvider

      public AwsCredentialProvider.Builder mergeAssumeRoleWithWebIdentityProvider(AssumeRoleWithWebIdentityCredentialProvider value)
       The option to use `AssumeRoleWithWebIdentity <https://docs.aws.amazon.com/STS/latest/APIReference/API_AssumeRoleWithWebIdentity.html>`_.
      .envoy.extensions.common.aws.v3.AssumeRoleWithWebIdentityCredentialProvider assume_role_with_web_identity_provider = 1;

    • clearAssumeRoleWithWebIdentityProvider

      public AwsCredentialProvider.Builder clearAssumeRoleWithWebIdentityProvider()
       The option to use `AssumeRoleWithWebIdentity <https://docs.aws.amazon.com/STS/latest/APIReference/API_AssumeRoleWithWebIdentity.html>`_.
      .envoy.extensions.common.aws.v3.AssumeRoleWithWebIdentityCredentialProvider assume_role_with_web_identity_provider = 1;

    • getAssumeRoleWithWebIdentityProviderBuilder

      public AssumeRoleWithWebIdentityCredentialProvider.Builder getAssumeRoleWithWebIdentityProviderBuilder()
       The option to use `AssumeRoleWithWebIdentity <https://docs.aws.amazon.com/STS/latest/APIReference/API_AssumeRoleWithWebIdentity.html>`_.
      .envoy.extensions.common.aws.v3.AssumeRoleWithWebIdentityCredentialProvider assume_role_with_web_identity_provider = 1;

    • getAssumeRoleWithWebIdentityProviderOrBuilder

      public AssumeRoleWithWebIdentityCredentialProviderOrBuilder getAssumeRoleWithWebIdentityProviderOrBuilder()
       The option to use `AssumeRoleWithWebIdentity <https://docs.aws.amazon.com/STS/latest/APIReference/API_AssumeRoleWithWebIdentity.html>`_.
      .envoy.extensions.common.aws.v3.AssumeRoleWithWebIdentityCredentialProvider assume_role_with_web_identity_provider = 1;
      Specified by:
      getAssumeRoleWithWebIdentityProviderOrBuilder in interface AwsCredentialProviderOrBuilder

    • hasInlineCredential

      public boolean hasInlineCredential()
       The option to use an inline credential. If inline credential is provided, no chain will be created and only the inline credential will be used.
      .envoy.extensions.common.aws.v3.InlineCredentialProvider inline_credential = 2;
      Specified by:
      hasInlineCredential in interface AwsCredentialProviderOrBuilder
      Returns:
      Whether the inlineCredential field is set.

    • getInlineCredential

      public InlineCredentialProvider getInlineCredential()
       The option to use an inline credential. If inline credential is provided, no chain will be created and only the inline credential will be used.
      .envoy.extensions.common.aws.v3.InlineCredentialProvider inline_credential = 2;
      Specified by:
      getInlineCredential in interface AwsCredentialProviderOrBuilder
      Returns:
      The inlineCredential.

    • setInlineCredential

      public AwsCredentialProvider.Builder setInlineCredential(InlineCredentialProvider value)
       The option to use an inline credential. If inline credential is provided, no chain will be created and only the inline credential will be used.
      .envoy.extensions.common.aws.v3.InlineCredentialProvider inline_credential = 2;

    • setInlineCredential

      public AwsCredentialProvider.Builder setInlineCredential(InlineCredentialProvider.Builder builderForValue)
       The option to use an inline credential. If inline credential is provided, no chain will be created and only the inline credential will be used.
      .envoy.extensions.common.aws.v3.InlineCredentialProvider inline_credential = 2;

    • mergeInlineCredential

      public AwsCredentialProvider.Builder mergeInlineCredential(InlineCredentialProvider value)
       The option to use an inline credential. If inline credential is provided, no chain will be created and only the inline credential will be used.
      .envoy.extensions.common.aws.v3.InlineCredentialProvider inline_credential = 2;

    • clearInlineCredential

      public AwsCredentialProvider.Builder clearInlineCredential()
       The option to use an inline credential. If inline credential is provided, no chain will be created and only the inline credential will be used.
      .envoy.extensions.common.aws.v3.InlineCredentialProvider inline_credential = 2;

    • getInlineCredentialBuilder

      public InlineCredentialProvider.Builder getInlineCredentialBuilder()
       The option to use an inline credential. If inline credential is provided, no chain will be created and only the inline credential will be used.
      .envoy.extensions.common.aws.v3.InlineCredentialProvider inline_credential = 2;

    • getInlineCredentialOrBuilder

      public InlineCredentialProviderOrBuilder getInlineCredentialOrBuilder()
       The option to use an inline credential. If inline credential is provided, no chain will be created and only the inline credential will be used.
      .envoy.extensions.common.aws.v3.InlineCredentialProvider inline_credential = 2;
      Specified by:
      getInlineCredentialOrBuilder in interface AwsCredentialProviderOrBuilder

    • hasCredentialsFileProvider

      public boolean hasCredentialsFileProvider()
       The option to specify parameters for credential retrieval from an envoy data source, such as a file in AWS credential format.
      .envoy.extensions.common.aws.v3.CredentialsFileCredentialProvider credentials_file_provider = 3;
      Specified by:
      hasCredentialsFileProvider in interface AwsCredentialProviderOrBuilder
      Returns:
      Whether the credentialsFileProvider field is set.

    • getCredentialsFileProvider

      public CredentialsFileCredentialProvider getCredentialsFileProvider()
       The option to specify parameters for credential retrieval from an envoy data source, such as a file in AWS credential format.
      .envoy.extensions.common.aws.v3.CredentialsFileCredentialProvider credentials_file_provider = 3;
      Specified by:
      getCredentialsFileProvider in interface AwsCredentialProviderOrBuilder
      Returns:
      The credentialsFileProvider.

    • setCredentialsFileProvider

      public AwsCredentialProvider.Builder setCredentialsFileProvider(CredentialsFileCredentialProvider value)
       The option to specify parameters for credential retrieval from an envoy data source, such as a file in AWS credential format.
      .envoy.extensions.common.aws.v3.CredentialsFileCredentialProvider credentials_file_provider = 3;

    • setCredentialsFileProvider

      public AwsCredentialProvider.Builder setCredentialsFileProvider(CredentialsFileCredentialProvider.Builder builderForValue)
       The option to specify parameters for credential retrieval from an envoy data source, such as a file in AWS credential format.
      .envoy.extensions.common.aws.v3.CredentialsFileCredentialProvider credentials_file_provider = 3;

    • mergeCredentialsFileProvider

      public AwsCredentialProvider.Builder mergeCredentialsFileProvider(CredentialsFileCredentialProvider value)
       The option to specify parameters for credential retrieval from an envoy data source, such as a file in AWS credential format.
      .envoy.extensions.common.aws.v3.CredentialsFileCredentialProvider credentials_file_provider = 3;

    • clearCredentialsFileProvider

      public AwsCredentialProvider.Builder clearCredentialsFileProvider()
       The option to specify parameters for credential retrieval from an envoy data source, such as a file in AWS credential format.
      .envoy.extensions.common.aws.v3.CredentialsFileCredentialProvider credentials_file_provider = 3;

    • getCredentialsFileProviderBuilder

      public CredentialsFileCredentialProvider.Builder getCredentialsFileProviderBuilder()
       The option to specify parameters for credential retrieval from an envoy data source, such as a file in AWS credential format.
      .envoy.extensions.common.aws.v3.CredentialsFileCredentialProvider credentials_file_provider = 3;

    • getCredentialsFileProviderOrBuilder

      public CredentialsFileCredentialProviderOrBuilder getCredentialsFileProviderOrBuilder()
       The option to specify parameters for credential retrieval from an envoy data source, such as a file in AWS credential format.
      .envoy.extensions.common.aws.v3.CredentialsFileCredentialProvider credentials_file_provider = 3;
      Specified by:
      getCredentialsFileProviderOrBuilder in interface AwsCredentialProviderOrBuilder

    • getCustomCredentialProviderChain

      public boolean getCustomCredentialProviderChain()
       Create a custom credential provider chain instead of the default credential provider chain.
 If set to TRUE, the credential provider chain that is created contains only those set in this credential provider message.
 If set to FALSE, the settings provided here will act as modifiers to the default credential provider chain.
 Defaults to FALSE.

 This has no effect if inline_credential is provided.
      bool custom_credential_provider_chain = 4;
      Specified by:
      getCustomCredentialProviderChain in interface AwsCredentialProviderOrBuilder
      Returns:
      The customCredentialProviderChain.

    • setCustomCredentialProviderChain

      public AwsCredentialProvider.Builder setCustomCredentialProviderChain(boolean value)
       Create a custom credential provider chain instead of the default credential provider chain.
 If set to TRUE, the credential provider chain that is created contains only those set in this credential provider message.
 If set to FALSE, the settings provided here will act as modifiers to the default credential provider chain.
 Defaults to FALSE.

 This has no effect if inline_credential is provided.
      bool custom_credential_provider_chain = 4;
      Parameters:
      value - The customCredentialProviderChain to set.
      Returns:
      This builder for chaining.

    • clearCustomCredentialProviderChain

      public AwsCredentialProvider.Builder clearCustomCredentialProviderChain()
       Create a custom credential provider chain instead of the default credential provider chain.
 If set to TRUE, the credential provider chain that is created contains only those set in this credential provider message.
 If set to FALSE, the settings provided here will act as modifiers to the default credential provider chain.
 Defaults to FALSE.

 This has no effect if inline_credential is provided.
      bool custom_credential_provider_chain = 4;
      Returns:
      This builder for chaining.

    • setUnknownFields

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

    • mergeUnknownFields

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