@Generated(value="software.amazon.awssdk:codegen") public final class CreateDocumentationVersionRequest extends ApiGatewayRequest implements ToCopyableBuilder<CreateDocumentationVersionRequest.Builder,CreateDocumentationVersionRequest>
Creates a new documentation version of a given API.
Modifier and Type | Class and Description |
---|---|
static interface |
CreateDocumentationVersionRequest.Builder |
Modifier and Type | Method and Description |
---|---|
static CreateDocumentationVersionRequest.Builder |
builder() |
String |
description()
A description about the new documentation snapshot.
|
String |
documentationVersion()
[Required] The version identifier of the new snapshot.
|
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
SdkRequest . |
int |
hashCode() |
String |
restApiId()
[Required] The string identifier of the associated RestApi.
|
List<SdkField<?>> |
sdkFields() |
static Class<? extends CreateDocumentationVersionRequest.Builder> |
serializableBuilderClass() |
String |
stageName()
The stage name to be associated with the new documentation snapshot.
|
CreateDocumentationVersionRequest.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.
|
overrideConfiguration
copy
public final String restApiId()
[Required] The string identifier of the associated RestApi.
public final String documentationVersion()
[Required] The version identifier of the new snapshot.
public final String stageName()
The stage name to be associated with the new documentation snapshot.
public final String description()
A description about the new documentation snapshot.
public CreateDocumentationVersionRequest.Builder toBuilder()
ToCopyableBuilder
toBuilder
in interface ToCopyableBuilder<CreateDocumentationVersionRequest.Builder,CreateDocumentationVersionRequest>
toBuilder
in class ApiGatewayRequest
public static CreateDocumentationVersionRequest.Builder builder()
public static Class<? extends CreateDocumentationVersionRequest.Builder> serializableBuilderClass()
public final int hashCode()
hashCode
in class AwsRequest
public final boolean equals(Object obj)
equals
in class AwsRequest
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)
SdkRequest
SdkRequest
. 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 SdkRequest.getValueForField(String, Class)
method will
again be available.getValueForField
in class SdkRequest
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.