Interface GetOauth2CredentialProviderResponse.Builder

All Superinterfaces:
AwsResponse.Builder, BedrockAgentCoreControlResponse.Builder, Buildable, CopyableBuilder<GetOauth2CredentialProviderResponse.Builder,GetOauth2CredentialProviderResponse>, SdkBuilder<GetOauth2CredentialProviderResponse.Builder,GetOauth2CredentialProviderResponse>, SdkPojo, SdkResponse.Builder
Enclosing class:
GetOauth2CredentialProviderResponse
@Mutable @NotThreadSafe public static interface GetOauth2CredentialProviderResponse.Builder extends BedrockAgentCoreControlResponse.Builder, SdkPojo, CopyableBuilder<GetOauth2CredentialProviderResponse.Builder,GetOauth2CredentialProviderResponse>

  • Method Details

    • clientSecretArn

      GetOauth2CredentialProviderResponse.Builder clientSecretArn(Secret clientSecretArn)

      The Amazon Resource Name (ARN) of the client secret in Amazon Web Services Secrets Manager.

      Parameters:
      clientSecretArn - The Amazon Resource Name (ARN) of the client secret in Amazon Web Services Secrets Manager.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • clientSecretArn

      default GetOauth2CredentialProviderResponse.Builder clientSecretArn(Consumer<Secret.Builder> clientSecretArn)

      The Amazon Resource Name (ARN) of the client secret in Amazon Web Services Secrets Manager.

      This is a convenience method that creates an instance of the Secret.Builder avoiding the need to create one manually via Secret.builder().

      When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to clientSecretArn(Secret).

      Parameters:
      clientSecretArn - a consumer that will call methods on Secret.Builder
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • clientSecretJsonKey

      GetOauth2CredentialProviderResponse.Builder clientSecretJsonKey(String clientSecretJsonKey)

      The JSON key used to extract the client secret value from the Amazon Web Services Secrets Manager secret.

      Parameters:
      clientSecretJsonKey - The JSON key used to extract the client secret value from the Amazon Web Services Secrets Manager secret.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • clientSecretSource

      GetOauth2CredentialProviderResponse.Builder clientSecretSource(String clientSecretSource)

      The source type of the client secret. Either MANAGED if the secret is managed by the service, or EXTERNAL if managed by the user in Amazon Web Services Secrets Manager.

      Parameters:
      clientSecretSource - The source type of the client secret. Either MANAGED if the secret is managed by the service, or EXTERNAL if managed by the user in Amazon Web Services Secrets Manager.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • clientSecretSource

      GetOauth2CredentialProviderResponse.Builder clientSecretSource(SecretSourceType clientSecretSource)

      The source type of the client secret. Either MANAGED if the secret is managed by the service, or EXTERNAL if managed by the user in Amazon Web Services Secrets Manager.

      Parameters:
      clientSecretSource - The source type of the client secret. Either MANAGED if the secret is managed by the service, or EXTERNAL if managed by the user in Amazon Web Services Secrets Manager.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • name

      GetOauth2CredentialProviderResponse.Builder name(String name)

      The name of the OAuth2 credential provider.

      Parameters:
      name - The name of the OAuth2 credential provider.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • credentialProviderArn

      GetOauth2CredentialProviderResponse.Builder credentialProviderArn(String credentialProviderArn)

      ARN of the credential provider requested.

      Parameters:
      credentialProviderArn - ARN of the credential provider requested.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • credentialProviderVendor

      GetOauth2CredentialProviderResponse.Builder credentialProviderVendor(String credentialProviderVendor)

      The vendor of the OAuth2 credential provider.

      Parameters:
      credentialProviderVendor - The vendor of the OAuth2 credential provider.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • credentialProviderVendor

      GetOauth2CredentialProviderResponse.Builder credentialProviderVendor(CredentialProviderVendorType credentialProviderVendor)

      The vendor of the OAuth2 credential provider.

      Parameters:
      credentialProviderVendor - The vendor of the OAuth2 credential provider.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • callbackUrl

      GetOauth2CredentialProviderResponse.Builder callbackUrl(String callbackUrl)

      Callback URL to register on the OAuth2 credential provider as an allowed callback URL. This URL is where the OAuth2 authorization server redirects users after they complete the authorization flow.

      Parameters:
      callbackUrl - Callback URL to register on the OAuth2 credential provider as an allowed callback URL. This URL is where the OAuth2 authorization server redirects users after they complete the authorization flow.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • oauth2ProviderConfigOutput

      GetOauth2CredentialProviderResponse.Builder oauth2ProviderConfigOutput(Oauth2ProviderConfigOutput oauth2ProviderConfigOutput)

      The configuration output for the OAuth2 provider.

      Parameters:
      oauth2ProviderConfigOutput - The configuration output for the OAuth2 provider.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • oauth2ProviderConfigOutput

      default GetOauth2CredentialProviderResponse.Builder oauth2ProviderConfigOutput(Consumer<Oauth2ProviderConfigOutput.Builder> oauth2ProviderConfigOutput)

      The configuration output for the OAuth2 provider.

      This is a convenience method that creates an instance of the Oauth2ProviderConfigOutput.Builder avoiding the need to create one manually via Oauth2ProviderConfigOutput.builder().

      When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to oauth2ProviderConfigOutput(Oauth2ProviderConfigOutput).

      Parameters:
      oauth2ProviderConfigOutput - a consumer that will call methods on Oauth2ProviderConfigOutput.Builder
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • createdTime

      GetOauth2CredentialProviderResponse.Builder createdTime(Instant createdTime)

      The timestamp when the OAuth2 credential provider was created.

      Parameters:
      createdTime - The timestamp when the OAuth2 credential provider was created.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • lastUpdatedTime

      GetOauth2CredentialProviderResponse.Builder lastUpdatedTime(Instant lastUpdatedTime)

      The timestamp when the OAuth2 credential provider was last updated.

      Parameters:
      lastUpdatedTime - The timestamp when the OAuth2 credential provider was last updated.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • status

      GetOauth2CredentialProviderResponse.Builder status(String status)

      The current status of the OAuth2 credential provider.

      Parameters:
      status - The current status of the OAuth2 credential provider.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • status

      GetOauth2CredentialProviderResponse.Builder status(Status status)

      The current status of the OAuth2 credential provider.

      Parameters:
      status - The current status of the OAuth2 credential provider.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • failureReason

      GetOauth2CredentialProviderResponse.Builder failureReason(String failureReason)

      The reason for failure if the OAuth2 credential provider is in a failed state.

      Parameters:
      failureReason - The reason for failure if the OAuth2 credential provider is in a failed state.
      Returns:
      Returns a reference to this object so that method calls can be chained together.