Interface GetConsentPortalResponse.Builder

All Superinterfaces:

AwsResponse.Builder, BedrockAgentCoreControlResponse.Builder, Buildable, CopyableBuilder<GetConsentPortalResponse.Builder,GetConsentPortalResponse>, SdkBuilder<GetConsentPortalResponse.Builder,GetConsentPortalResponse>, SdkPojo, SdkResponse.Builder

Enclosing class:

GetConsentPortalResponse

@Mutable
@NotThreadSafe
public static interface GetConsentPortalResponse.Builder
extends BedrockAgentCoreControlResponse.Builder, SdkPojo, CopyableBuilder<GetConsentPortalResponse.Builder,GetConsentPortalResponse>

Method Summary

Modifier and Type	Method	Description
GetConsentPortalResponse.Builder	consentPortalArn(String consentPortalArn)	The Amazon Resource Name (ARN) of the consent portal.
GetConsentPortalResponse.Builder	consentPortalId(String consentPortalId)	The unique identifier of the consent portal.
GetConsentPortalResponse.Builder	createdAt(Instant createdAt)	The timestamp for when the consent portal was created.
GetConsentPortalResponse.Builder	description(String description)	The description of the consent portal.
GetConsentPortalResponse.Builder	executionRoleArn(String executionRoleArn)	The Amazon Resource Name (ARN) of the IAM role that the consent portal assumes to access the resources defined in its sources.
default GetConsentPortalResponse.Builder	idpConfig(Consumer<ConsentPortalIdpConfig.Builder> idpConfig)	The identity provider configuration that the consent portal uses to authenticate end users.
GetConsentPortalResponse.Builder	idpConfig(ConsentPortalIdpConfig idpConfig)	The identity provider configuration that the consent portal uses to authenticate end users.
GetConsentPortalResponse.Builder	name(String name)	The name of the consent portal.
GetConsentPortalResponse.Builder	portalUrl(String portalUrl)	The URL used to access the consent portal.
GetConsentPortalResponse.Builder	sources(Collection<ConsentPortalSource> sources)	The resources served by the consent portal.
GetConsentPortalResponse.Builder	sources(Consumer<ConsentPortalSource.Builder>... sources)	The resources served by the consent portal.
GetConsentPortalResponse.Builder	sources(ConsentPortalSource... sources)	The resources served by the consent portal.
GetConsentPortalResponse.Builder	status(String status)	The current status of the consent portal.
GetConsentPortalResponse.Builder	status(ConsentPortalStatus status)	The current status of the consent portal.
GetConsentPortalResponse.Builder	statusReason(String statusReason)	A message that provides additional information about the current status of the consent portal.
GetConsentPortalResponse.Builder	updatedAt(Instant updatedAt)	The timestamp for when the consent portal was last updated.

Methods inherited from interface software.amazon.awssdk.services.bedrockagentcorecontrol.model.BedrockAgentCoreControlResponse.Builder

build, responseMetadata, responseMetadata

Methods inherited from interface software.amazon.awssdk.utils.builder.CopyableBuilder

copy

Methods inherited from interface software.amazon.awssdk.utils.builder.SdkBuilder

applyMutation, build

Methods inherited from interface software.amazon.awssdk.core.SdkPojo

equalsBySdkFields, sdkFieldNameToField, sdkFields

Methods inherited from interface software.amazon.awssdk.core.SdkResponse.Builder

sdkHttpResponse, sdkHttpResponse

Method Details

sources

GetConsentPortalResponse.Builder sources(Collection<ConsentPortalSource> sources)

The resources served by the consent portal.

Parameters:

sources - The resources served by the consent portal.

Returns:

Returns a reference to this object so that method calls can be chained together.

sources

GetConsentPortalResponse.Builder sources(ConsentPortalSource... sources)

The resources served by the consent portal.

Parameters:

sources - The resources served by the consent portal.

Returns:

Returns a reference to this object so that method calls can be chained together.

sources

GetConsentPortalResponse.Builder sources(Consumer<ConsentPortalSource.Builder>... sources)

The resources served by the consent portal.

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

When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to sources(List<ConsentPortalSource>).

Parameters:

sources - a consumer that will call methods on ConsentPortalSource.Builder

Returns:

Returns a reference to this object so that method calls can be chained together.

See Also:

• sources(java.util.Collection<ConsentPortalSource>)

consentPortalArn

GetConsentPortalResponse.Builder consentPortalArn(String consentPortalArn)

The Amazon Resource Name (ARN) of the consent portal.

Parameters:

consentPortalArn - The Amazon Resource Name (ARN) of the consent portal.

Returns:

Returns a reference to this object so that method calls can be chained together.

consentPortalId

GetConsentPortalResponse.Builder consentPortalId(String consentPortalId)

The unique identifier of the consent portal.

Parameters:

consentPortalId - The unique identifier of the consent portal.

Returns:

Returns a reference to this object so that method calls can be chained together.

createdAt

GetConsentPortalResponse.Builder createdAt(Instant createdAt)

The timestamp for when the consent portal was created.

Parameters:

createdAt - The timestamp for when the consent portal was created.

Returns:

Returns a reference to this object so that method calls can be chained together.

description

GetConsentPortalResponse.Builder description(String description)

The description of the consent portal.

Parameters:

description - The description of the consent portal.

Returns:

Returns a reference to this object so that method calls can be chained together.

executionRoleArn

GetConsentPortalResponse.Builder executionRoleArn(String executionRoleArn)

The Amazon Resource Name (ARN) of the IAM role that the consent portal assumes to access the resources defined in its sources.

Parameters:

executionRoleArn - The Amazon Resource Name (ARN) of the IAM role that the consent portal assumes to access the resources defined in its sources.

Returns:

Returns a reference to this object so that method calls can be chained together.

idpConfig

GetConsentPortalResponse.Builder idpConfig(ConsentPortalIdpConfig idpConfig)

The identity provider configuration that the consent portal uses to authenticate end users.

Parameters:

idpConfig - The identity provider configuration that the consent portal uses to authenticate end users.

Returns:

Returns a reference to this object so that method calls can be chained together.

idpConfig

default GetConsentPortalResponse.Builder idpConfig(Consumer<ConsentPortalIdpConfig.Builder> idpConfig)

The identity provider configuration that the consent portal uses to authenticate end users.

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

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

Parameters:

idpConfig - a consumer that will call methods on ConsentPortalIdpConfig.Builder

Returns:

Returns a reference to this object so that method calls can be chained together.

See Also:

• idpConfig(ConsentPortalIdpConfig)

name

GetConsentPortalResponse.Builder name(String name)

The name of the consent portal.

Parameters:

name - The name of the consent portal.

Returns:

Returns a reference to this object so that method calls can be chained together.

portalUrl

GetConsentPortalResponse.Builder portalUrl(String portalUrl)

The URL used to access the consent portal.

Parameters:

portalUrl - The URL used to access the consent portal.

Returns:

Returns a reference to this object so that method calls can be chained together.

status

GetConsentPortalResponse.Builder status(String status)

The current status of the consent portal.

Parameters:

status - The current status of the consent portal.

Returns:

Returns a reference to this object so that method calls can be chained together.

See Also:

• ConsentPortalStatus
• ConsentPortalStatus

status

GetConsentPortalResponse.Builder status(ConsentPortalStatus status)

The current status of the consent portal.

Parameters:

status - The current status of the consent portal.

Returns:

Returns a reference to this object so that method calls can be chained together.

See Also:

• ConsentPortalStatus
• ConsentPortalStatus

statusReason

GetConsentPortalResponse.Builder statusReason(String statusReason)

A message that provides additional information about the current status of the consent portal.

Parameters:

statusReason - A message that provides additional information about the current status of the consent portal.

Returns:

Returns a reference to this object so that method calls can be chained together.

updatedAt

GetConsentPortalResponse.Builder updatedAt(Instant updatedAt)

The timestamp for when the consent portal was last updated.

Parameters:

updatedAt - The timestamp for when the consent portal was last updated.

Returns:

Returns a reference to this object so that method calls can be chained together.