io.envoyproxy.envoy.extensions.common.aws.v3.AwsCredentialProviderOrBuilder Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of api Show documentation
The newest version!
// Generated by the protocol buffer compiler.  DO NOT EDIT!
// source: envoy/extensions/common/aws/v3/credential_provider.proto

// Protobuf Java Version: 3.25.1
package io.envoyproxy.envoy.extensions.common.aws.v3;

public interface AwsCredentialProviderOrBuilder extends
    // @@protoc_insertion_point(interface_extends:envoy.extensions.common.aws.v3.AwsCredentialProvider)
    com.google.protobuf.MessageOrBuilder {

  /**
   *    * 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;
   * @return Whether the assumeRoleWithWebIdentityProvider field is set.
   */
  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;
   * @return The assumeRoleWithWebIdentityProvider.
   */
  io.envoyproxy.envoy.extensions.common.aws.v3.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;
   */
  io.envoyproxy.envoy.extensions.common.aws.v3.AssumeRoleWithWebIdentityCredentialProviderOrBuilder getAssumeRoleWithWebIdentityProviderOrBuilder();

  /**
   *    * 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;
   * @return Whether the inlineCredential field is set.
   */
  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;
   * @return The inlineCredential.
   */
  io.envoyproxy.envoy.extensions.common.aws.v3.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;
   */
  io.envoyproxy.envoy.extensions.common.aws.v3.InlineCredentialProviderOrBuilder getInlineCredentialOrBuilder();

  /**
   *    * 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;
   * @return Whether the credentialsFileProvider field is set.
   */
  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;
   * @return The credentialsFileProvider.
   */
  io.envoyproxy.envoy.extensions.common.aws.v3.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;
   */
  io.envoyproxy.envoy.extensions.common.aws.v3.CredentialsFileCredentialProviderOrBuilder getCredentialsFileProviderOrBuilder();

  /**
   *    * 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;
   * @return The customCredentialProviderChain.
   */
  boolean getCustomCredentialProviderChain();
}