Package software.amazon.awssdk.services.apigateway.model

Interface GetDeploymentRequest.Builder

All Superinterfaces:

CopyableBuilder<GetDeploymentRequest.Builder,GetDeploymentRequest>, SdkBuilder<GetDeploymentRequest.Builder,GetDeploymentRequest>

Enclosing class:

GetDeploymentRequest

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

Method Summary

Modifier and Type	Method	Description
GetDeploymentRequest.Builder	deploymentId(String deploymentId)	The identifier of the Deployment resource to get information about.
GetDeploymentRequest.Builder	embed(String... embed)	A query parameter to retrieve the specified embedded resources of the returned Deployment resource in the response.
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	restApiId(String restApiId)	The identifier of the RestApi resource for the Deployment resource to get information about.

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 identifier of the RestApi resource for the Deployment resource to get information about.

Parameters:

restApiId - The identifier of the RestApi resource for the Deployment resource to get information about.

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.

NOTE: This method appends the values to the existing list (if any). Use #setEmbed(java.util.Collection) or #withEmbed(java.util.Collection) if you want to override the existing values.

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.