DocumentationPartState class

Input properties used for looking up and filtering DocumentationPart resources.

Constructors

DocumentationPartState({Input<String?>? documentationPartId, Input<DocumentationPartLocation?>? location, Input<String?>? properties, Input<String?>? region, Input<String?>? restApiId})
Creates a new DocumentationPartState. documentationPartId DocumentationPart identifier, generated by API Gateway when the documentation part is created. location Location of the targeted API entity of the to-be-created documentation part. See below. properties Content map of API-specific key-value pairs describing the targeted API entity. The map must be encoded as a JSON string, e.g., "{ "description": "The API does ..." }". Only Swagger-compliant key-value pairs can be exported and, hence, published. region Region where this resource will be managed. Defaults to the Region set in the provider configuration. restApiId ID of the associated Rest API
const
DocumentationPartState.fromMap(Map<String, dynamic> map)
factory

Properties

documentationPartId → Input<String?>?
DocumentationPart identifier, generated by API Gateway when the documentation part is created.
final
hashCode → int
The hash code for this object.
no setterinherited
location → Input<DocumentationPartLocation?>?
Location of the targeted API entity of the to-be-created documentation part. See below.
final
properties → Input<String?>?
Content map of API-specific key-value pairs describing the targeted API entity. The map must be encoded as a JSON string, e.g., "{ "description": "The API does ..." }". Only Swagger-compliant key-value pairs can be exported and, hence, published.
final
region → Input<String?>?
Region where this resource will be managed. Defaults to the Region set in the provider configuration.
final
restApiId → Input<String?>?
ID of the associated Rest API
final
runtimeType → Type
A representation of the runtime type of the object.
no setterinherited

Methods

noSuchMethod(Invocation invocation) → dynamic
Invoked when a nonexistent method or property is accessed.
inherited
toMap() → Map<String, dynamic>
toString() → String
A string representation of this object.
inherited

Operators

operator ==(Object other) → bool
The equality operator.
inherited