software.amazon.awssdk.services.apigateway.model

Interface GetDeploymentRequest.Builder

All Superinterfaces:

APIGatewayRequest.Builder, AwsRequest.Builder, CopyableBuilder<GetDeploymentRequest.Builder,GetDeploymentRequest>, SdkBuilder<GetDeploymentRequest.Builder,GetDeploymentRequest>, SdkRequest.Builder

Enclosing class:

GetDeploymentRequest

public static interface GetDeploymentRequest.Builder
extends APIGatewayRequest.Builder, CopyableBuilder<GetDeploymentRequest.Builder,GetDeploymentRequest>

Method Summary

Modifier and Type	Method and Description
GetDeploymentRequest.Builder	deploymentId(String deploymentId) The identifier of the Deployment resource to get information about.
GetDeploymentRequest.Builder	embed(Collection<String> embed) A query parameter to retrieve the specified embedded resources of the returned Deployment resource in the response.
GetDeploymentRequest.Builder	embed(String... embed) A query parameter to retrieve the specified embedded resources of the returned Deployment resource in the response.
GetDeploymentRequest.Builder	requestOverrideConfig(AwsRequestOverrideConfig awsRequestOverrideConfig) Add an optional request override configuration.
GetDeploymentRequest.Builder	requestOverrideConfig(Consumer<AwsRequestOverrideConfig.Builder> builderConsumer) Add an optional request override configuration.
GetDeploymentRequest.Builder	restApiId(String restApiId) The string identifier of the associated RestApi.

Methods inherited from interface software.amazon.awssdk.services.apigateway.model.APIGatewayRequest.Builder

build

Methods inherited from interface software.amazon.awssdk.awscore.AwsRequest.Builder

requestOverrideConfig

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

copy

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

apply, build

Method Detail

restApiId

GetDeploymentRequest.Builder restApiId(String restApiId)

The string identifier of the associated RestApi.

Parameters:

restApiId - The string identifier of the associated RestApi.

Returns:

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

deploymentId

GetDeploymentRequest.Builder deploymentId(String deploymentId)

The identifier of the Deployment resource to get information about.

Parameters:

deploymentId - The identifier of the Deployment resource to get information about.

Returns:

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

embed

GetDeploymentRequest.Builder embed(Collection<String> embed)

A query parameter to retrieve the specified embedded resources of the returned Deployment resource in the response. In a REST API call, this embed parameter value is a list of comma-separated strings, as in GET /restapis/{restapi_id}/deployments/{deployment_id}?embed=var1,var2. The SDK and other platform-dependent libraries might use a different format for the list. Currently, this request supports only retrieval of the embedded API summary this way. Hence, the parameter value must be a single-valued list containing only the "apisummary" string. For example, GET /restapis/{restapi_id}/deployments/{deployment_id}?embed=apisummary.

Parameters:

embed - A query parameter to retrieve the specified embedded resources of the returned Deployment resource in the response. In a REST API call, this embed parameter value is a list of comma-separated strings, as in GET /restapis/{restapi_id}/deployments/{deployment_id}?embed=var1,var2. The SDK and other platform-dependent libraries might use a different format for the list. Currently, this request supports only retrieval of the embedded API summary this way. Hence, the parameter value must be a single-valued list containing only the "apisummary" string. For example, GET /restapis/{restapi_id}/deployments/{deployment_id}?embed=apisummary.

Returns:

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

embed

GetDeploymentRequest.Builder embed(String... embed)

A query parameter to retrieve the specified embedded resources of the returned Deployment resource in the response. In a REST API call, this embed parameter value is a list of comma-separated strings, as in GET /restapis/{restapi_id}/deployments/{deployment_id}?embed=var1,var2. The SDK and other platform-dependent libraries might use a different format for the list. Currently, this request supports only retrieval of the embedded API summary this way. Hence, the parameter value must be a single-valued list containing only the "apisummary" string. For example, GET /restapis/{restapi_id}/deployments/{deployment_id}?embed=apisummary.

Parameters:

embed - A query parameter to retrieve the specified embedded resources of the returned Deployment resource in the response. In a REST API call, this embed parameter value is a list of comma-separated strings, as in GET /restapis/{restapi_id}/deployments/{deployment_id}?embed=var1,var2. The SDK and other platform-dependent libraries might use a different format for the list. Currently, this request supports only retrieval of the embedded API summary this way. Hence, the parameter value must be a single-valued list containing only the "apisummary" string. For example, GET /restapis/{restapi_id}/deployments/{deployment_id}?embed=apisummary.

Returns:

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

requestOverrideConfig

GetDeploymentRequest.Builder requestOverrideConfig(AwsRequestOverrideConfig awsRequestOverrideConfig)

Description copied from interface: AwsRequest.Builder

Add an optional request override configuration.

Specified by:

requestOverrideConfig in interface AwsRequest.Builder

Parameters:

awsRequestOverrideConfig - The override configuration.

Returns:

This object for method chaining.

requestOverrideConfig

GetDeploymentRequest.Builder requestOverrideConfig(Consumer<AwsRequestOverrideConfig.Builder> builderConsumer)

Description copied from interface: AwsRequest.Builder

Add an optional request override configuration.

Specified by:

requestOverrideConfig in interface AwsRequest.Builder

Parameters:

builderConsumer - A Consumer to which an empty AwsRequestOverrideConfig.Builder will be given.

Returns:

This object for method chaining.