GetExportArgs class
Arguments for getExport. Arguments for getExport.
Constructors
-
GetExportArgs({required Input<
String> apiId, Input<String?> ? exportVersion, Input<bool?> ? includeExtensions, required Input<String> outputType, Input<String?> ? region, required Input<String> specification, Input<String?> ? stageName}) -
Creates a new GetExportArgs.
apiIdAPI identifier.exportVersionVersion of the API Gateway export algorithm. API Gateway uses the latest version by default. Currently, the only supported version is1.0.includeExtensionsWhether to include API Gateway extensions in the exported API definition. API Gateway extensions are included by default.outputTypeOutput type of the exported definition file. Valid values areJSONandYAML.regionRegion where this resource will be managed. Defaults to the Region set in the provider configuration.specificationVersion of the API specification to use.OAS30, for OpenAPI 3.0, is the only supported value.stageNameName of the API stage to export. If you don't specify this property, a representation of the latest API configuration is exported.const -
GetExportArgs.fromMap(Map<
String, dynamic> map) -
factory
Properties
-
apiId
→ Input<
String> -
API identifier.
final
-
exportVersion
→ Input<
String?> ? -
Version of the API Gateway export algorithm. API Gateway uses the latest version by default. Currently, the only supported version is
1.0.final - hashCode → int
-
The hash code for this object.
no setterinherited
-
includeExtensions
→ Input<
bool?> ? -
Whether to include API Gateway extensions in the exported API definition. API Gateway extensions are included by default.
final
-
outputType
→ Input<
String> -
Output type of the exported definition file. Valid values are
JSONandYAML.final -
region
→ Input<
String?> ? -
Region where this resource will be managed. Defaults to the Region set in the provider configuration.
final
- runtimeType → Type
-
A representation of the runtime type of the object.
no setterinherited
-
specification
→ Input<
String> -
Version of the API specification to use.
OAS30, for OpenAPI 3.0, is the only supported value.final -
stageName
→ Input<
String?> ? -
Name of the API stage to export. If you don't specify this property, a representation of the latest API configuration is exported.
final
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