Package software.amazon.awscdk.mixins.preview.services.apigateway.mixins

Class CfnDocumentationPartPropsMixin.LocationProperty.Jsii$Proxy

java.lang.Object

software.amazon.jsii.JsiiObject

software.amazon.awscdk.mixins.preview.services.apigateway.mixins.CfnDocumentationPartPropsMixin.LocationProperty.Jsii$Proxy

All Implemented Interfaces:

CfnDocumentationPartPropsMixin.LocationProperty, software.amazon.jsii.JsiiSerializable

Enclosing interface:

CfnDocumentationPartPropsMixin.LocationProperty

@Stability(Stable)
@Internal
public static final class CfnDocumentationPartPropsMixin.LocationProperty.Jsii$Proxy
extends software.amazon.jsii.JsiiObject
implements CfnDocumentationPartPropsMixin.LocationProperty

An implementation for CfnDocumentationPartPropsMixin.LocationProperty

Nested Class Summary

Nested classes/interfaces inherited from class software.amazon.jsii.JsiiObject

software.amazon.jsii.JsiiObject.InitializationMode

Nested classes/interfaces inherited from interface software.amazon.awscdk.mixins.preview.services.apigateway.mixins.CfnDocumentationPartPropsMixin.LocationProperty

CfnDocumentationPartPropsMixin.LocationProperty.Builder, CfnDocumentationPartPropsMixin.LocationProperty.Jsii$Proxy

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	Jsii$Proxy(CfnDocumentationPartPropsMixin.LocationProperty.Builder builder)	Constructor that initializes the object based on literal property values passed by the CfnDocumentationPartPropsMixin.LocationProperty.Builder.
protected	Jsii$Proxy(software.amazon.jsii.JsiiObjectRef objRef)	Constructor that initializes the object based on values retrieved from the JsiiObject.

Method Summary

Modifier and Type	Method	Description
com.fasterxml.jackson.databind.JsonNode	$jsii$toJson()
final boolean	equals(Object o)
final String	getMethod()	The HTTP verb of a method.
final String	getName()	The name of the targeted API entity.
final String	getPath()	The URL path of the target.
final String	getStatusCode()	The HTTP status code of a response.
final String	getType()	The type of API entity to which the documentation content applies.
final int	hashCode()

Methods inherited from class software.amazon.jsii.JsiiObject

jsiiAsyncCall, jsiiAsyncCall, jsiiCall, jsiiCall, jsiiGet, jsiiGet, jsiiSet, jsiiStaticCall, jsiiStaticCall, jsiiStaticGet, jsiiStaticGet, jsiiStaticSet, jsiiStaticSet

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, toString, wait, wait, wait

Constructor Details

Jsii$Proxy

protected Jsii$Proxy(software.amazon.jsii.JsiiObjectRef objRef)

Constructor that initializes the object based on values retrieved from the JsiiObject.

Parameters:

objRef - Reference to the JSII managed object.

Jsii$Proxy

protected Jsii$Proxy(CfnDocumentationPartPropsMixin.LocationProperty.Builder builder)

Constructor that initializes the object based on literal property values passed by the CfnDocumentationPartPropsMixin.LocationProperty.Builder.

Method Details

getMethod

public final String getMethod()

Description copied from interface: CfnDocumentationPartPropsMixin.LocationProperty

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.

Specified by:

getMethod in interface CfnDocumentationPartPropsMixin.LocationProperty

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-apigateway-documentationpart-location.html#cfn-apigateway-documentationpart-location-method

getName

public final String getName()

Description copied from interface: CfnDocumentationPartPropsMixin.LocationProperty

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.

Specified by:

getName in interface CfnDocumentationPartPropsMixin.LocationProperty

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-apigateway-documentationpart-location.html#cfn-apigateway-documentationpart-location-name

getPath

public final String getPath()

Description copied from interface: CfnDocumentationPartPropsMixin.LocationProperty

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.

Specified by:

getPath in interface CfnDocumentationPartPropsMixin.LocationProperty

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-apigateway-documentationpart-location.html#cfn-apigateway-documentationpart-location-path

getStatusCode

public final String getStatusCode()

Description copied from interface: CfnDocumentationPartPropsMixin.LocationProperty

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.

Specified by:

getStatusCode in interface CfnDocumentationPartPropsMixin.LocationProperty

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-apigateway-documentationpart-location.html#cfn-apigateway-documentationpart-location-statuscode

getType

public final String getType()

Description copied from interface: CfnDocumentationPartPropsMixin.LocationProperty

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.

Specified by:

getType in interface CfnDocumentationPartPropsMixin.LocationProperty

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-apigateway-documentationpart-location.html#cfn-apigateway-documentationpart-location-type

$jsii$toJson

@Internal
public com.fasterxml.jackson.databind.JsonNode $jsii$toJson()

Specified by:

$jsii$toJson in interface software.amazon.jsii.JsiiSerializable

equals

public final boolean equals(Object o)

Overrides:

equals in class Object

hashCode

public final int hashCode()

Overrides:

hashCode in class Object