Class CfnDocumentationPartPropsMixin.LocationProperty.Builder
java.lang.Object
software.amazon.awscdk.cfnpropertymixins.services.apigateway.CfnDocumentationPartPropsMixin.LocationProperty.Builder
- All Implemented Interfaces:
software.amazon.jsii.Builder<CfnDocumentationPartPropsMixin.LocationProperty>
- Enclosing interface:
CfnDocumentationPartPropsMixin.LocationProperty
@Stability(Stable)
public static final class CfnDocumentationPartPropsMixin.LocationProperty.Builder
extends Object
implements software.amazon.jsii.Builder<CfnDocumentationPartPropsMixin.LocationProperty>
A builder for
CfnDocumentationPartPropsMixin.LocationProperty-
Constructor Summary
Constructors -
Method Summary
Modifier and TypeMethodDescriptionbuild()Builds the configured instance.Sets the value ofCfnDocumentationPartPropsMixin.LocationProperty.getMethod()Sets the value ofCfnDocumentationPartPropsMixin.LocationProperty.getName()Sets the value ofCfnDocumentationPartPropsMixin.LocationProperty.getPath()statusCode(String statusCode) Sets the value ofCfnDocumentationPartPropsMixin.LocationProperty.getStatusCode()Sets the value ofCfnDocumentationPartPropsMixin.LocationProperty.getType()
-
Constructor Details
-
Builder
public Builder()
-
-
Method Details
-
method
@Stability(Stable) public CfnDocumentationPartPropsMixin.LocationProperty.Builder method(String method) Sets the value ofCfnDocumentationPartPropsMixin.LocationProperty.getMethod()- Parameters:
method- The HTTP verb of a method. It is a valid field for the API entity types ofMETHOD,PATH_PARAMETER,QUERY_PARAMETER,REQUEST_HEADER,REQUEST_BODY,RESPONSE,RESPONSE_HEADER, andRESPONSE_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 otherlocationattributes, the child entity'smethodattribute must match that of the parent entity exactly.- Returns:
this
-
name
Sets the value ofCfnDocumentationPartPropsMixin.LocationProperty.getName()- Parameters:
name- The name of the targeted API entity. It is a valid and required field for the API entity types ofAUTHORIZER,MODEL,PATH_PARAMETER,QUERY_PARAMETER,REQUEST_HEADER,REQUEST_BODYandRESPONSE_HEADER. It is an invalid field for any other entity type.- Returns:
this
-
path
Sets the value ofCfnDocumentationPartPropsMixin.LocationProperty.getPath()- Parameters:
path- The URL path of the target. It is a valid field for the API entity types ofRESOURCE,METHOD,PATH_PARAMETER,QUERY_PARAMETER,REQUEST_HEADER,REQUEST_BODY,RESPONSE,RESPONSE_HEADER, andRESPONSE_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 otherlocationattributes, the child entity'spathattribute must match that of the parent entity as a prefix.- Returns:
this
-
statusCode
@Stability(Stable) public CfnDocumentationPartPropsMixin.LocationProperty.Builder statusCode(String statusCode) Sets the value ofCfnDocumentationPartPropsMixin.LocationProperty.getStatusCode()- Parameters:
statusCode- The HTTP status code of a response. It is a valid field for the API entity types ofRESPONSE,RESPONSE_HEADER, andRESPONSE_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 otherlocationattributes, the child entity'sstatusCodeattribute must match that of the parent entity exactly.- Returns:
this
-
type
Sets the value ofCfnDocumentationPartPropsMixin.LocationProperty.getType()- Parameters:
type- The type of API entity to which the documentation content applies. Valid values areAPI,AUTHORIZER,MODEL,RESOURCE,METHOD,PATH_PARAMETER,QUERY_PARAMETER,REQUEST_HEADER,REQUEST_BODY,RESPONSE,RESPONSE_HEADER, andRESPONSE_BODY. Content inheritance does not apply to any entity of theAPI,AUTHORIZER,METHOD,MODEL,REQUEST_BODY, orRESOURCEtype.- Returns:
this
-
build
Builds the configured instance.- Specified by:
buildin interfacesoftware.amazon.jsii.Builder<CfnDocumentationPartPropsMixin.LocationProperty>- Returns:
- a new instance of
CfnDocumentationPartPropsMixin.LocationProperty - Throws:
NullPointerException- if any required attribute was not provided
-