DocumentationPartArgs class
The set of arguments for DocumentationPart. The set of arguments for DocumentationPart.
Constructors
-
DocumentationPartArgs({required Input<
DocumentationPartLocation> location, required Input<String> properties, Input<String?> ? region, required Input<String> restApiId}) -
Creates a new DocumentationPartArgs.
locationLocation of the targeted API entity of the to-be-created documentation part. See below.propertiesContent 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.regionRegion where this resource will be managed. Defaults to the Region set in the provider configuration.restApiIdID of the associated Rest APIconst -
DocumentationPartArgs.fromMap(Map<
String, dynamic> map) -
factory
Properties
- 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