Class CreateKxChangesetResponse
- All Implemented Interfaces:
SdkPojo,ToCopyableBuilder<CreateKxChangesetResponse.Builder,CreateKxChangesetResponse>
-
Nested Class Summary
Nested Classes -
Method Summary
Modifier and TypeMethodDescriptionbuilder()final List<ChangeRequest> A list of change requests.final StringA unique identifier for the changeset.final InstantThe timestamp at which the changeset was created in FinSpace.final StringThe name of the kdb database.final StringA unique identifier for the kdb environment.final booleanfinal booleanequalsBySdkFields(Object obj) Indicates whether some other object is "equal to" this one by SDK fields.final ErrorInfoThe details of the error that you receive when creating a changeset.final <T> Optional<T> getValueForField(String fieldName, Class<T> clazz) Used to retrieve the value of a field from any class that extendsSdkResponse.final booleanFor responses, this returns true if the service returned a value for the ChangeRequests property.final inthashCode()final InstantThe timestamp at which the changeset was updated in FinSpace.static Class<? extends CreateKxChangesetResponse.Builder> final ChangesetStatusstatus()Status of the changeset creation process.final StringStatus of the changeset creation process.Take this object and create a builder that contains all of the current property values of this object.final StringtoString()Returns a string representation of this object.Methods inherited from class software.amazon.awssdk.services.finspace.model.FinspaceResponse
responseMetadataMethods inherited from class software.amazon.awssdk.core.SdkResponse
sdkHttpResponseMethods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder
copy
-
Method Details
-
changesetId
A unique identifier for the changeset.
- Returns:
- A unique identifier for the changeset.
-
databaseName
The name of the kdb database.
- Returns:
- The name of the kdb database.
-
environmentId
A unique identifier for the kdb environment.
- Returns:
- A unique identifier for the kdb environment.
-
hasChangeRequests
public final boolean hasChangeRequests()For responses, this returns true if the service returned a value for the ChangeRequests property. This DOES NOT check that the value is non-empty (for which, you should check theisEmpty()method on the property). This is useful because the SDK will never return a null collection or map, but you may need to differentiate between the service returning nothing (or null) and the service returning an empty collection or map. For requests, this returns true if a value for the property was specified in the request builder, and false if a value was not specified. -
changeRequests
A list of change requests.
Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.
This method will never return null. If you would like to know whether the service returned this field (so that you can differentiate between null and empty), you can use the
hasChangeRequests()method.- Returns:
- A list of change requests.
-
createdTimestamp
The timestamp at which the changeset was created in FinSpace. The value is determined as epoch time in milliseconds. For example, the value for Monday, November 1, 2021 12:00:00 PM UTC is specified as 1635768000000.
- Returns:
- The timestamp at which the changeset was created in FinSpace. The value is determined as epoch time in milliseconds. For example, the value for Monday, November 1, 2021 12:00:00 PM UTC is specified as 1635768000000.
-
lastModifiedTimestamp
The timestamp at which the changeset was updated in FinSpace. The value is determined as epoch time in milliseconds. For example, the value for Monday, November 1, 2021 12:00:00 PM UTC is specified as 1635768000000.
- Returns:
- The timestamp at which the changeset was updated in FinSpace. The value is determined as epoch time in milliseconds. For example, the value for Monday, November 1, 2021 12:00:00 PM UTC is specified as 1635768000000.
-
status
Status of the changeset creation process.
-
Pending – Changeset creation is pending.
-
Processing – Changeset creation is running.
-
Failed – Changeset creation has failed.
-
Complete – Changeset creation has succeeded.
If the service returns an enum value that is not available in the current SDK version,
statuswill returnChangesetStatus.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available fromstatusAsString().- Returns:
- Status of the changeset creation process.
-
Pending – Changeset creation is pending.
-
Processing – Changeset creation is running.
-
Failed – Changeset creation has failed.
-
Complete – Changeset creation has succeeded.
-
- See Also:
-
-
statusAsString
Status of the changeset creation process.
-
Pending – Changeset creation is pending.
-
Processing – Changeset creation is running.
-
Failed – Changeset creation has failed.
-
Complete – Changeset creation has succeeded.
If the service returns an enum value that is not available in the current SDK version,
statuswill returnChangesetStatus.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available fromstatusAsString().- Returns:
- Status of the changeset creation process.
-
Pending – Changeset creation is pending.
-
Processing – Changeset creation is running.
-
Failed – Changeset creation has failed.
-
Complete – Changeset creation has succeeded.
-
- See Also:
-
-
errorInfo
The details of the error that you receive when creating a changeset. It consists of the type of error and the error message.
- Returns:
- The details of the error that you receive when creating a changeset. It consists of the type of error and the error message.
-
toBuilder
Description copied from interface:ToCopyableBuilderTake this object and create a builder that contains all of the current property values of this object.- Specified by:
toBuilderin interfaceToCopyableBuilder<CreateKxChangesetResponse.Builder,CreateKxChangesetResponse> - Specified by:
toBuilderin classAwsResponse- Returns:
- a builder for type T
-
builder
-
serializableBuilderClass
-
hashCode
public final int hashCode()- Overrides:
hashCodein classAwsResponse
-
equals
- Overrides:
equalsin classAwsResponse
-
equalsBySdkFields
Description copied from interface:SdkPojoIndicates whether some other object is "equal to" this one by SDK fields. An SDK field is a modeled, non-inherited field in anSdkPojoclass, and is generated based on a service model.If an
SdkPojoclass does not have any inherited fields,equalsBySdkFieldsandequalsare essentially the same.- Specified by:
equalsBySdkFieldsin interfaceSdkPojo- Parameters:
obj- the object to be compared with- Returns:
- true if the other object equals to this object by sdk fields, false otherwise.
-
toString
-
getValueForField
Description copied from class:SdkResponseUsed to retrieve the value of a field from any class that extendsSdkResponse. 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, theSdkResponse.getValueForField(String, Class)method will again be available.- Overrides:
getValueForFieldin classSdkResponse- Parameters:
fieldName- The name of the member to be retrieved.clazz- The class to cast the returned object to.- Returns:
- Optional containing the casted return value
-
sdkFields
-
sdkFieldNameToField
- Specified by:
sdkFieldNameToFieldin interfaceSdkPojo- Returns:
- The mapping between the field name and its corresponding field.
-