Package software.amazon.awscdk.services.apigateway

Class CfnDocumentationPart.LocationProperty.Builder

java.lang.Object
software.amazon.awscdk.services.apigateway.CfnDocumentationPart.LocationProperty.Builder
All Implemented Interfaces:
software.amazon.jsii.Builder<CfnDocumentationPart.LocationProperty>
Enclosing interface:
CfnDocumentationPart.LocationProperty
@Stability(Stable) public static final class CfnDocumentationPart.LocationProperty.Builder extends Object implements software.amazon.jsii.Builder<CfnDocumentationPart.LocationProperty>
A builder for CfnDocumentationPart.LocationProperty

  • Constructor Details

    • Builder

      public Builder()

  • Method Details

    • method

      @Stability(Stable) public CfnDocumentationPart.LocationProperty.Builder method(String method)
      Sets the value of CfnDocumentationPart.LocationProperty.getMethod()
      Parameters:
      method - The HTTP verb of a method. It is a valid field for the API entity types of METHOD , PATH_PARAMETER , QUERY_PARAMETER , REQUEST_HEADER , REQUEST_BODY , RESPONSE , RESPONSE_HEADER , and RESPONSE_BODY . The default value is * for any method. When an applicable child entity inherits the content of an entity of the same type with more general specifications of the other location attributes, the child entity's method attribute must match that of the parent entity exactly.
      Returns:
      this

    • name

      @Stability(Stable) public CfnDocumentationPart.LocationProperty.Builder name(String name)
      Sets the value of CfnDocumentationPart.LocationProperty.getName()
      Parameters:
      name - The name of the targeted API entity. It is a valid and required field for the API entity types of AUTHORIZER , MODEL , PATH_PARAMETER , QUERY_PARAMETER , REQUEST_HEADER , REQUEST_BODY and RESPONSE_HEADER . It is an invalid field for any other entity type.
      Returns:
      this

    • path

      @Stability(Stable) public CfnDocumentationPart.LocationProperty.Builder path(String path)
      Sets the value of CfnDocumentationPart.LocationProperty.getPath()
      Parameters:
      path - The URL path of the target. It is a valid field for the API entity types of RESOURCE , METHOD , PATH_PARAMETER , QUERY_PARAMETER , REQUEST_HEADER , REQUEST_BODY , RESPONSE , RESPONSE_HEADER , and RESPONSE_BODY . The default value is / for the root resource. When an applicable child entity inherits the content of another entity of the same type with more general specifications of the other location attributes, the child entity's path attribute must match that of the parent entity as a prefix.
      Returns:
      this

    • statusCode

      @Stability(Stable) public CfnDocumentationPart.LocationProperty.Builder statusCode(String statusCode)
      Sets the value of CfnDocumentationPart.LocationProperty.getStatusCode()
      Parameters:
      statusCode - The HTTP status code of a response. It is a valid field for the API entity types of RESPONSE , RESPONSE_HEADER , and RESPONSE_BODY . The default value is * for any status code. When an applicable child entity inherits the content of an entity of the same type with more general specifications of the other location attributes, the child entity's statusCode attribute must match that of the parent entity exactly.
      Returns:
      this

    • type

      @Stability(Stable) public CfnDocumentationPart.LocationProperty.Builder type(String type)
      Sets the value of CfnDocumentationPart.LocationProperty.getType()
      Parameters:
      type - The type of API entity to which the documentation content applies. Valid values are API , AUTHORIZER , MODEL , RESOURCE , METHOD , PATH_PARAMETER , QUERY_PARAMETER , REQUEST_HEADER , REQUEST_BODY , RESPONSE , RESPONSE_HEADER , and RESPONSE_BODY . Content inheritance does not apply to any entity of the API , AUTHORIZER , METHOD , MODEL , REQUEST_BODY , or RESOURCE type.
      Returns:
      this

    • build

      @Stability(Stable) public CfnDocumentationPart.LocationProperty build()
      Builds the configured instance.
      Specified by:
      build in interface software.amazon.jsii.Builder<CfnDocumentationPart.LocationProperty>
      Returns:
      a new instance of CfnDocumentationPart.LocationProperty
      Throws:
      NullPointerException - if any required attribute was not provided