java.lang.Object
- software.amazon.awssdk.core.SdkRequest
- - software.amazon.awssdk.awscore.AwsRequest
  - - software.amazon.awssdk.services.finspace.model.FinspaceRequest
    - - software.amazon.awssdk.services.finspace.model.CreateKxDataviewRequest

All Implemented Interfaces:: SdkPojo, ToCopyableBuilder<CreateKxDataviewRequest.Builder,CreateKxDataviewRequest>

@Generated("software.amazon.awssdk:codegen")
public final class CreateKxDataviewRequest
extends FinspaceRequest
implements ToCopyableBuilder<CreateKxDataviewRequest.Builder,CreateKxDataviewRequest>

Nested Class Summary

Nested Classes
Modifier and Type Class Description

static interface CreateKxDataviewRequest.Builder

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method	Description
`Boolean`	`autoUpdate()`	The option to specify whether you want to apply all the future additions and corrections automatically to the dataview, when you ingest new changesets.
`String`	`availabilityZoneId()`	The identifier of the availability zones.
`KxAzMode`	`azMode()`	The number of availability zones you want to assign per volume.
`String`	`azModeAsString()`	The number of availability zones you want to assign per volume.
`static CreateKxDataviewRequest.Builder`	`builder()`
`String`	`changesetId()`	A unique identifier of the changeset that you want to use to ingest data.
`String`	`clientToken()`	A token that ensures idempotency.
`String`	`databaseName()`	The name of the database where you want to create a dataview.
`String`	`dataviewName()`	A unique identifier for the dataview.
`String`	`description()`	A description of the dataview.
`String`	`environmentId()`	A unique identifier for the kdb environment, where you want to create the dataview.
`boolean`	`equals(Object obj)`
`boolean`	`equalsBySdkFields(Object obj)`
`<T> Optional<T>`	`getValueForField(String fieldName, Class<T> clazz)`
`int`	`hashCode()`
`boolean`	`hasSegmentConfigurations()`	For responses, this returns true if the service returned a value for the SegmentConfigurations property.
`boolean`	`hasTags()`	For responses, this returns true if the service returned a value for the Tags property.
`Boolean`	`readWrite()`	The option to specify whether you want to make the dataview writable to perform database maintenance.
`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 CreateKxDataviewRequest.Builder>`	`serializableBuilderClass()`
`Map<String,String>`	`tags()`	A list of key-value pairs to label the dataview.
`CreateKxDataviewRequest.Builder`	`toBuilder()`
`String`	`toString()`	Returns a string representation of this object.

Methods inherited from class software.amazon.awssdk.awscore.AwsRequest
overrideConfiguration

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 create the dataview.
    
    Returns:
    
    A unique identifier for the kdb environment, where you want to create the dataview.
  - databaseName
```
public final String databaseName()
```
    The name of the database where you want to create a dataview.
    
    Returns:
    
    The name of the database where you want to create a dataview.
  - dataviewName
```
public final String dataviewName()
```
    A unique identifier for the dataview.
    
    Returns:
    
    A unique identifier for the dataview.
  - azMode
```
public final KxAzMode azMode()
```
    The number of availability zones you want to assign per volume. Currently, FinSpace only supports SINGLE for volumes. This places dataview in a single AZ.
    
    If the service returns an enum value that is not available in the current SDK version, azMode will return KxAzMode.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from azModeAsString().
    
    Returns:
    
    The number of availability zones you want to assign per volume. Currently, FinSpace only supports SINGLE for 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 SINGLE for volumes. This places dataview in a single AZ.
    
    If the service returns an enum value that is not available in the current SDK version, azMode will return KxAzMode.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from azModeAsString().
    
    Returns:
    
    The number of availability zones you want to assign per volume. Currently, FinSpace only supports SINGLE for 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 of the changeset that you want to use to ingest data.
    
    Returns:
    
    A unique identifier of the changeset that you want to use to ingest data.
  - 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 the isEmpty() 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.
  - 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 you ingest new changesets. 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 you ingest new changesets. The default value is false.
  - readWrite
```
public final Boolean readWrite()
```
    The option to specify whether you want to make the dataview writable to perform database maintenance. The following are some considerations related to writable dataviews.  
    
    You cannot create partial writable dataviews. When you create writeable dataviews you must provide the entire database path.
    
    You cannot perform updates on a writeable dataview. Hence, autoUpdate must be set as False if readWrite is True for a dataview.
    
    You must also use a unique volume for creating a writeable dataview. So, if you choose a volume that is already in use by another dataview, the dataview creation fails.
    
    Once you create a dataview as writeable, you cannot change it to read-only. So, you cannot update the readWrite parameter later.
    Returns:
    
    The option to specify whether you want to make the dataview writable to perform database maintenance. The following are some considerations related to writable dataviews.  
    
    You cannot create partial writable dataviews. When you create writeable dataviews you must provide the entire database path.
    
    You cannot perform updates on a writeable dataview. Hence, autoUpdate must be set as False if readWrite is True for a dataview.
    
    You must also use a unique volume for creating a writeable dataview. So, if you choose a volume that is already in use by another dataview, the dataview creation fails.
    
    Once you create a dataview as writeable, you cannot change it to read-only. So, you cannot update the readWrite parameter later.
  - description
```
public final String description()
```
    A description of the dataview.
    
    Returns:
    
    A description of the dataview.
  - hasTags
```
public final boolean hasTags()
```
    For responses, this returns true if the service returned a value for the Tags property. This DOES NOT check that the value is non-empty (for which, you should check the isEmpty() 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.
  - tags
```
public final Map<String,String> tags()
```
    A list of key-value pairs to label the dataview. You can add up to 50 tags to a 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 hasTags() method.
    
    Returns:
    
    A list of key-value pairs to label the dataview. You can add up to 50 tags to a dataview.
  - clientToken
```
public final String clientToken()
```
    A token that ensures idempotency. This token expires in 10 minutes.
    
    Returns:
    
    A token that ensures idempotency. This token expires in 10 minutes.
  - toBuilder
```
public CreateKxDataviewRequest.Builder toBuilder()
```
    Specified by:
    
    toBuilder in interface ToCopyableBuilder<CreateKxDataviewRequest.Builder,CreateKxDataviewRequest>
    
    Specified by:
    
    toBuilder in class FinspaceRequest
  - builder
```
public static CreateKxDataviewRequest.Builder builder()
```
  - serializableBuilderClass
```
public static Class<? extends CreateKxDataviewRequest.Builder> serializableBuilderClass()
```
  - hashCode
```
public final int hashCode()
```
    Overrides:
    
    hashCode in class AwsRequest
  - equals
```
public final boolean equals(Object obj)
```
    Overrides:
    
    equals in class AwsRequest
  - equalsBySdkFields
```
public final boolean equalsBySdkFields(Object obj)
```
    Specified by:
    
    equalsBySdkFields in interface SdkPojo
  - 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.
    
    Overrides:
    
    toString in class Object
  - getValueForField
```
public final <T> Optional<T> getValueForField(String fieldName,
                                              Class<T> clazz)
```
    Overrides:
    
    getValueForField in class SdkRequest
  - sdkFields
```
public final List<SdkField<?>> sdkFields()
```
    Specified by:
    
    sdkFields in interface SdkPojo
  - sdkFieldNameToField
```
public final Map<String,SdkField<?>> sdkFieldNameToField()
```
    Specified by:
    
    sdkFieldNameToField in interface SdkPojo

Class CreateKxDataviewRequest

Nested Class Summary

Method Summary

Methods inherited from class software.amazon.awssdk.awscore.AwsRequest

Methods inherited from class java.lang.Object

Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder

Method Detail

environmentId

databaseName

dataviewName

azMode

azModeAsString

availabilityZoneId

changesetId

hasSegmentConfigurations

segmentConfigurations

autoUpdate

readWrite

description

hasTags

tags

clientToken

toBuilder

builder

serializableBuilderClass

hashCode

equals

equalsBySdkFields

toString

getValueForField

sdkFields

sdkFieldNameToField