@Generated(value="software.amazon.awssdk:codegen") public final class UpdateApiResponse extends ApiGatewayV2Response implements ToCopyableBuilder<UpdateApiResponse.Builder,UpdateApiResponse>
Modifier and Type | Class and Description |
---|---|
static interface |
UpdateApiResponse.Builder |
Modifier and Type | Method and Description |
---|---|
String |
apiEndpoint()
The URI of the API, of the form {api-id}.execute-api.{region}.amazonaws.com.
|
Boolean |
apiGatewayManaged()
Specifies whether an API is managed by API Gateway.
|
String |
apiId()
The API ID.
|
String |
apiKeySelectionExpression()
An API key selection expression.
|
static UpdateApiResponse.Builder |
builder() |
Cors |
corsConfiguration()
A CORS configuration.
|
Instant |
createdDate()
The timestamp when the API was created.
|
String |
description()
The description of the API.
|
Boolean |
disableExecuteApiEndpoint()
Specifies whether clients can invoke your API by using the default execute-api endpoint.
|
Boolean |
disableSchemaValidation()
Avoid validating models when creating a deployment.
|
boolean |
equals(Object obj) |
boolean |
equalsBySdkFields(Object obj)
Indicates whether some other object is "equal to" this one by SDK fields.
|
<T> Optional<T> |
getValueForField(String fieldName,
Class<T> clazz)
Used to retrieve the value of a field from any class that extends
SdkResponse . |
int |
hashCode() |
boolean |
hasImportInfo()
Returns true if the ImportInfo property was specified by the sender (it may be empty), or false if the sender did
not specify the value (it will be empty).
|
boolean |
hasTags()
Returns true if the Tags property was specified by the sender (it may be empty), or false if the sender did not
specify the value (it will be empty).
|
boolean |
hasWarnings()
Returns true if the Warnings property was specified by the sender (it may be empty), or false if the sender did
not specify the value (it will be empty).
|
List<String> |
importInfo()
The validation information during API import.
|
String |
name()
The name of the API.
|
ProtocolType |
protocolType()
The API protocol.
|
String |
protocolTypeAsString()
The API protocol.
|
String |
routeSelectionExpression()
The route selection expression for the API.
|
List<SdkField<?>> |
sdkFields() |
static Class<? extends UpdateApiResponse.Builder> |
serializableBuilderClass() |
Map<String,String> |
tags()
A collection of tags associated with the API.
|
UpdateApiResponse.Builder |
toBuilder()
Take this object and create a builder that contains all of the current property values of this object.
|
String |
toString()
Returns a string representation of this object.
|
String |
version()
A version identifier for the API.
|
List<String> |
warnings()
The warning messages reported when failonwarnings is turned on during API import.
|
responseMetadata
sdkHttpResponse
copy
public final String apiEndpoint()
The URI of the API, of the form {api-id}.execute-api.{region}.amazonaws.com. The stage name is typically appended to this URI to form a complete path to a deployed API stage.
public final Boolean apiGatewayManaged()
Specifies whether an API is managed by API Gateway. You can't update or delete a managed API by using API Gateway. A managed API can be deleted only through the tooling or service that created it.
public final String apiId()
The API ID.
public final String apiKeySelectionExpression()
An API key selection expression. Supported only for WebSocket APIs. See API Key Selection Expressions.
public final Cors corsConfiguration()
A CORS configuration. Supported only for HTTP APIs.
public final Instant createdDate()
The timestamp when the API was created.
public final String description()
The description of the API.
public final Boolean disableSchemaValidation()
Avoid validating models when creating a deployment. Supported only for WebSocket APIs.
public final Boolean disableExecuteApiEndpoint()
Specifies whether clients can invoke your API by using the default execute-api endpoint. By default, clients can invoke your API with the default https://{api_id}.execute-api.{region}.amazonaws.com endpoint. To require that clients use a custom domain name to invoke your API, disable the default endpoint.
public final boolean hasImportInfo()
public final List<String> importInfo()
The validation information during API import. This may include particular properties of your OpenAPI definition which are ignored during import. Supported only for HTTP APIs.
Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.
You can use hasImportInfo()
to see if a value was sent in this field.
public final String name()
The name of the API.
public final ProtocolType protocolType()
The API protocol.
If the service returns an enum value that is not available in the current SDK version, protocolType
will
return ProtocolType.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available from
protocolTypeAsString()
.
ProtocolType
public final String protocolTypeAsString()
The API protocol.
If the service returns an enum value that is not available in the current SDK version, protocolType
will
return ProtocolType.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available from
protocolTypeAsString()
.
ProtocolType
public final String routeSelectionExpression()
The route selection expression for the API. For HTTP APIs, the routeSelectionExpression must be ${request.method} ${request.path}. If not provided, this will be the default for HTTP APIs. This property is required for WebSocket APIs.
public final boolean hasTags()
public final Map<String,String> tags()
A collection of tags associated with the API.
Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.
You can use hasTags()
to see if a value was sent in this field.
public final String version()
A version identifier for the API.
public final boolean hasWarnings()
public final List<String> warnings()
The warning messages reported when failonwarnings is turned on during API import.
Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.
You can use hasWarnings()
to see if a value was sent in this field.
public UpdateApiResponse.Builder toBuilder()
ToCopyableBuilder
toBuilder
in interface ToCopyableBuilder<UpdateApiResponse.Builder,UpdateApiResponse>
toBuilder
in class AwsResponse
public static UpdateApiResponse.Builder builder()
public static Class<? extends UpdateApiResponse.Builder> serializableBuilderClass()
public final int hashCode()
hashCode
in class AwsResponse
public final boolean equals(Object obj)
equals
in class AwsResponse
public final boolean equalsBySdkFields(Object obj)
SdkPojo
SdkPojo
class,
and is generated based on a service model.
If an SdkPojo
class does not have any inherited fields, equalsBySdkFields
and equals
are essentially the same.
equalsBySdkFields
in interface SdkPojo
obj
- the object to be compared withpublic final String toString()
public final <T> Optional<T> getValueForField(String fieldName, Class<T> clazz)
SdkResponse
SdkResponse
. The field name
specified should match the member name from the corresponding service-2.json model specified in the
codegen-resources folder for a given service. The class specifies what class to cast the returned value to.
If the returned value is also a modeled class, the SdkResponse.getValueForField(String, Class)
method will
again be available.getValueForField
in class SdkResponse
fieldName
- The name of the member to be retrieved.clazz
- The class to cast the returned object to.Copyright © 2021 Amazon Web Services, Inc. All Rights Reserved.