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

Interface GetDeploymentRequest.Builder

All Superinterfaces:
ApiGatewayRequest.Builder, AwsRequest.Builder, Buildable, CopyableBuilder<GetDeploymentRequest.Builder,GetDeploymentRequest>, SdkBuilder<GetDeploymentRequest.Builder,GetDeploymentRequest>, SdkPojo, SdkRequest.Builder
Enclosing class:
GetDeploymentRequest
@Mutable @NotThreadSafe public static interface GetDeploymentRequest.Builder extends ApiGatewayRequest.Builder, SdkPojo, CopyableBuilder<GetDeploymentRequest.Builder,GetDeploymentRequest>

  • Method Details

    • 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.

    • overrideConfiguration

      GetDeploymentRequest.Builder overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration)
      Specified by:
      overrideConfiguration in interface AwsRequest.Builder

    • overrideConfiguration

      GetDeploymentRequest.Builder overrideConfiguration(Consumer<AwsRequestOverrideConfiguration.Builder> builderConsumer)
      Specified by:
      overrideConfiguration in interface AwsRequest.Builder