Class DirectQueryDataSource
- java.lang.Object
-
- software.amazon.awssdk.services.opensearch.model.DirectQueryDataSource
-
- All Implemented Interfaces:
Serializable
,SdkPojo
,ToCopyableBuilder<DirectQueryDataSource.Builder,DirectQueryDataSource>
@Generated("software.amazon.awssdk:codegen") public final class DirectQueryDataSource extends Object implements SdkPojo, Serializable, ToCopyableBuilder<DirectQueryDataSource.Builder,DirectQueryDataSource>
The configuration details for a data source that can be directly queried.
- See Also:
- Serialized Form
-
-
Nested Class Summary
Nested Classes Modifier and Type Class Description static interface
DirectQueryDataSource.Builder
-
Method Summary
All Methods Static Methods Instance Methods Concrete Methods Modifier and Type Method Description static DirectQueryDataSource.Builder
builder()
String
dataSourceArn()
The unique, system-generated identifier that represents the data source.String
dataSourceName()
A unique, user-defined label to identify the data source within your OpenSearch Service environment.DirectQueryDataSourceType
dataSourceType()
The supported Amazon Web Services service that is used as the source for direct queries in OpenSearch Service.String
description()
A description that provides additional context and details about the data source.boolean
equals(Object obj)
boolean
equalsBySdkFields(Object obj)
<T> Optional<T>
getValueForField(String fieldName, Class<T> clazz)
int
hashCode()
boolean
hasOpenSearchArns()
For responses, this returns true if the service returned a value for the OpenSearchArns property.boolean
hasTagList()
For responses, this returns true if the service returned a value for the TagList property.List<String>
openSearchArns()
A list of Amazon Resource Names (ARNs) for the OpenSearch collections that are associated with the direct query data source.Map<String,SdkField<?>>
sdkFieldNameToField()
List<SdkField<?>>
sdkFields()
static Class<? extends DirectQueryDataSource.Builder>
serializableBuilderClass()
List<Tag>
tagList()
A list of tags attached to a direct query data source.DirectQueryDataSource.Builder
toBuilder()
String
toString()
Returns a string representation of this object.-
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
-
dataSourceName
public final String dataSourceName()
A unique, user-defined label to identify the data source within your OpenSearch Service environment.
- Returns:
- A unique, user-defined label to identify the data source within your OpenSearch Service environment.
-
dataSourceType
public final DirectQueryDataSourceType dataSourceType()
The supported Amazon Web Services service that is used as the source for direct queries in OpenSearch Service.
- Returns:
- The supported Amazon Web Services service that is used as the source for direct queries in OpenSearch Service.
-
description
public final String description()
A description that provides additional context and details about the data source.
- Returns:
- A description that provides additional context and details about the data source.
-
hasOpenSearchArns
public final boolean hasOpenSearchArns()
For responses, this returns true if the service returned a value for the OpenSearchArns 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.
-
openSearchArns
public final List<String> openSearchArns()
A list of Amazon Resource Names (ARNs) for the OpenSearch collections that are associated with the direct query data source.
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
hasOpenSearchArns()
method.- Returns:
- A list of Amazon Resource Names (ARNs) for the OpenSearch collections that are associated with the direct query data source.
-
dataSourceArn
public final String dataSourceArn()
The unique, system-generated identifier that represents the data source.
- Returns:
- The unique, system-generated identifier that represents the data source.
-
hasTagList
public final boolean hasTagList()
For responses, this returns true if the service returned a value for the TagList 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.
-
tagList
public final List<Tag> tagList()
A list of tags attached to a direct query data source.
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
hasTagList()
method.- Returns:
- A list of tags attached to a direct query data source.
-
toBuilder
public DirectQueryDataSource.Builder toBuilder()
- Specified by:
toBuilder
in interfaceToCopyableBuilder<DirectQueryDataSource.Builder,DirectQueryDataSource>
-
builder
public static DirectQueryDataSource.Builder builder()
-
serializableBuilderClass
public static Class<? extends DirectQueryDataSource.Builder> serializableBuilderClass()
-
equalsBySdkFields
public final boolean equalsBySdkFields(Object obj)
- Specified by:
equalsBySdkFields
in 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.
-
sdkFieldNameToField
public final Map<String,SdkField<?>> sdkFieldNameToField()
- Specified by:
sdkFieldNameToField
in interfaceSdkPojo
-
-