Class UpdateKxDataviewResponse
- java.lang.Object
-
- software.amazon.awssdk.core.SdkResponse
-
- software.amazon.awssdk.awscore.AwsResponse
-
- software.amazon.awssdk.services.finspace.model.FinspaceResponse
-
- software.amazon.awssdk.services.finspace.model.UpdateKxDataviewResponse
-
- All Implemented Interfaces:
SdkPojo,ToCopyableBuilder<UpdateKxDataviewResponse.Builder,UpdateKxDataviewResponse>
@Generated("software.amazon.awssdk:codegen") public final class UpdateKxDataviewResponse extends FinspaceResponse implements ToCopyableBuilder<UpdateKxDataviewResponse.Builder,UpdateKxDataviewResponse>
-
-
Nested Class Summary
Nested Classes Modifier and Type Class Description static interfaceUpdateKxDataviewResponse.Builder
-
Method Summary
All Methods Static Methods Instance Methods Concrete Methods Modifier and Type Method Description List<KxDataviewActiveVersion>activeVersions()The current active changeset versions of the database on the given dataview.BooleanautoUpdate()The option to specify whether you want to apply all the future additions and corrections automatically to the dataview when new changesets are ingested.StringavailabilityZoneId()The identifier of the availability zones.KxAzModeazMode()The number of availability zones you want to assign per volume.StringazModeAsString()The number of availability zones you want to assign per volume.static UpdateKxDataviewResponse.Builderbuilder()StringchangesetId()A unique identifier for the changeset.InstantcreatedTimestamp()The timestamp at which the dataview was created in FinSpace.StringdatabaseName()The name of the database.StringdataviewName()The name of the database under which the dataview was created.Stringdescription()A description of the dataview.StringenvironmentId()A unique identifier for the kdb environment, where you want to update the dataview.booleanequals(Object obj)booleanequalsBySdkFields(Object obj)<T> Optional<T>getValueForField(String fieldName, Class<T> clazz)booleanhasActiveVersions()For responses, this returns true if the service returned a value for the ActiveVersions property.inthashCode()booleanhasSegmentConfigurations()For responses, this returns true if the service returned a value for the SegmentConfigurations property.InstantlastModifiedTimestamp()The last time that the dataview was updated in FinSpace.BooleanreadWrite()Returns True if the dataview is created as writeable and False otherwise.Map<String,SdkField<?>>sdkFieldNameToField()List<SdkField<?>>sdkFields()List<KxDataviewSegmentConfiguration>segmentConfigurations()The configuration that contains the database path of the data that you want to place on each selected volume.static Class<? extends UpdateKxDataviewResponse.Builder>serializableBuilderClass()KxDataviewStatusstatus()The status of dataview creation.StringstatusAsString()The status of dataview creation.UpdateKxDataviewResponse.BuildertoBuilder()StringtoString()Returns a string representation of this object.-
Methods inherited from class software.amazon.awssdk.services.finspace.model.FinspaceResponse
responseMetadata
-
Methods inherited from class software.amazon.awssdk.core.SdkResponse
sdkHttpResponse
-
Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, wait, wait, wait
-
Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder
copy
-
-
-
-
Method Detail
-
environmentId
public final String environmentId()
A unique identifier for the kdb environment, where you want to update the dataview.
- Returns:
- A unique identifier for the kdb environment, where you want to update the dataview.
-
databaseName
public final String databaseName()
The name of the database.
- Returns:
- The name of the database.
-
dataviewName
public final String dataviewName()
The name of the database under which the dataview was created.
- Returns:
- The name of the database under which the dataview was created.
-
azMode
public final KxAzMode azMode()
The number of availability zones you want to assign per volume. Currently, FinSpace only supports
SINGLEfor volumes. This places dataview in a single AZ.If the service returns an enum value that is not available in the current SDK version,
azModewill returnKxAzMode.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available fromazModeAsString().- Returns:
- The number of availability zones you want to assign per volume. Currently, FinSpace only supports
SINGLEfor volumes. This places dataview in a single AZ. - See Also:
KxAzMode
-
azModeAsString
public final String azModeAsString()
The number of availability zones you want to assign per volume. Currently, FinSpace only supports
SINGLEfor volumes. This places dataview in a single AZ.If the service returns an enum value that is not available in the current SDK version,
azModewill returnKxAzMode.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available fromazModeAsString().- Returns:
- The number of availability zones you want to assign per volume. Currently, FinSpace only supports
SINGLEfor volumes. This places dataview in a single AZ. - See Also:
KxAzMode
-
availabilityZoneId
public final String availabilityZoneId()
The identifier of the availability zones.
- Returns:
- The identifier of the availability zones.
-
changesetId
public final String changesetId()
A unique identifier for the changeset.
- Returns:
- A unique identifier for the changeset.
-
hasSegmentConfigurations
public final boolean hasSegmentConfigurations()
For responses, this returns true if the service returned a value for the SegmentConfigurations 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.
-
segmentConfigurations
public final List<KxDataviewSegmentConfiguration> segmentConfigurations()
The configuration that contains the database path of the data that you want to place on each selected volume. Each segment must have a unique database path for each volume. If you do not explicitly specify any database path for a volume, they are accessible from the cluster through the default S3/object store segment.
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
hasSegmentConfigurations()method.- Returns:
- The configuration that contains the database path of the data that you want to place on each selected volume. Each segment must have a unique database path for each volume. If you do not explicitly specify any database path for a volume, they are accessible from the cluster through the default S3/object store segment.
-
hasActiveVersions
public final boolean hasActiveVersions()
For responses, this returns true if the service returned a value for the ActiveVersions 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.
-
activeVersions
public final List<KxDataviewActiveVersion> activeVersions()
The current active changeset versions of the database on the given dataview.
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
hasActiveVersions()method.- Returns:
- The current active changeset versions of the database on the given dataview.
-
status
public final KxDataviewStatus status()
The status of dataview creation.
-
CREATING– The dataview creation is in progress. -
UPDATING– The dataview is in the process of being updated. -
ACTIVE– The dataview is active.
If the service returns an enum value that is not available in the current SDK version,
statuswill returnKxDataviewStatus.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available fromstatusAsString().- Returns:
- The status of dataview creation.
-
CREATING– The dataview creation is in progress. -
UPDATING– The dataview is in the process of being updated. -
ACTIVE– The dataview is active.
-
- See Also:
KxDataviewStatus
-
-
statusAsString
public final String statusAsString()
The status of dataview creation.
-
CREATING– The dataview creation is in progress. -
UPDATING– The dataview is in the process of being updated. -
ACTIVE– The dataview is active.
If the service returns an enum value that is not available in the current SDK version,
statuswill returnKxDataviewStatus.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available fromstatusAsString().- Returns:
- The status of dataview creation.
-
CREATING– The dataview creation is in progress. -
UPDATING– The dataview is in the process of being updated. -
ACTIVE– The dataview is active.
-
- See Also:
KxDataviewStatus
-
-
autoUpdate
public final Boolean autoUpdate()
The option to specify whether you want to apply all the future additions and corrections automatically to the dataview when new changesets are ingested. The default value is false.
- Returns:
- The option to specify whether you want to apply all the future additions and corrections automatically to the dataview when new changesets are ingested. The default value is false.
-
readWrite
public final Boolean readWrite()
Returns True if the dataview is created as writeable and False otherwise.
- Returns:
- Returns True if the dataview is created as writeable and False otherwise.
-
description
public final String description()
A description of the dataview.
- Returns:
- A description of the dataview.
-
createdTimestamp
public final Instant createdTimestamp()
The timestamp at which the dataview 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 dataview 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
public final Instant lastModifiedTimestamp()
The last time that the dataview 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 last time that the dataview 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.
-
toBuilder
public UpdateKxDataviewResponse.Builder toBuilder()
- Specified by:
toBuilderin interfaceToCopyableBuilder<UpdateKxDataviewResponse.Builder,UpdateKxDataviewResponse>- Specified by:
toBuilderin classAwsResponse
-
builder
public static UpdateKxDataviewResponse.Builder builder()
-
serializableBuilderClass
public static Class<? extends UpdateKxDataviewResponse.Builder> serializableBuilderClass()
-
hashCode
public final int hashCode()
- Overrides:
hashCodein classAwsResponse
-
equals
public final boolean equals(Object obj)
- Overrides:
equalsin classAwsResponse
-
equalsBySdkFields
public final boolean equalsBySdkFields(Object obj)
- Specified by:
equalsBySdkFieldsin interfaceSdkPojo
-
toString
public final String toString()
Returns a string representation of this object. This is useful for testing and debugging. Sensitive data will be redacted from this string using a placeholder value.
-
getValueForField
public final <T> Optional<T> getValueForField(String fieldName, Class<T> clazz)
- Overrides:
getValueForFieldin classSdkResponse
-
sdkFieldNameToField
public final Map<String,SdkField<?>> sdkFieldNameToField()
- Specified by:
sdkFieldNameToFieldin interfaceSdkPojo
-
-