Package software.amazon.awssdk.services.opensearch.model

Class UpdateDirectQueryDataSourceRequest

java.lang.Object
software.amazon.awssdk.core.SdkRequest
software.amazon.awssdk.awscore.AwsRequest
software.amazon.awssdk.services.opensearch.model.OpenSearchRequest
software.amazon.awssdk.services.opensearch.model.UpdateDirectQueryDataSourceRequest
All Implemented Interfaces:
SdkPojo, ToCopyableBuilder<UpdateDirectQueryDataSourceRequest.Builder,UpdateDirectQueryDataSourceRequest>
@Generated("software.amazon.awssdk:codegen") public final class UpdateDirectQueryDataSourceRequest extends OpenSearchRequest implements ToCopyableBuilder<UpdateDirectQueryDataSourceRequest.Builder,UpdateDirectQueryDataSourceRequest>

  • Method Details

    • 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 you want to use as the source for direct queries in OpenSearch Service.

      Returns:
      The supported Amazon Web Services service that you want to use as the source for direct queries in OpenSearch Service.

    • description

      public final String description()

      An optional text field for providing additional context and details about the data source.

      Returns:
      An optional text field for providing 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 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.

    • openSearchArns

      public final List<String> openSearchArns()

      An optional list of Amazon Resource Names (ARNs) for the OpenSearch collections that are associated with the direct query data source. This field is required for CloudWatchLogs and SecurityLake datasource types.

      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:
      An optional list of Amazon Resource Names (ARNs) for the OpenSearch collections that are associated with the direct query data source. This field is required for CloudWatchLogs and SecurityLake datasource types.

    • dataSourceAccessPolicy

      public final String dataSourceAccessPolicy()

      An optional IAM access policy document that defines the updated permissions for accessing the direct query data source. The policy document must be in valid JSON format and follow IAM policy syntax. If not specified, the existing access policy if present remains unchanged.

      Returns:
      An optional IAM access policy document that defines the updated permissions for accessing the direct query data source. The policy document must be in valid JSON format and follow IAM policy syntax. If not specified, the existing access policy if present remains unchanged.

    • toBuilder

      public UpdateDirectQueryDataSourceRequest.Builder toBuilder()
      Specified by:
      toBuilder in interface ToCopyableBuilder<UpdateDirectQueryDataSourceRequest.Builder,UpdateDirectQueryDataSourceRequest>
      Specified by:
      toBuilder in class OpenSearchRequest

    • builder

      public static UpdateDirectQueryDataSourceRequest.Builder builder()

    • serializableBuilderClass

      public static Class<? extends UpdateDirectQueryDataSourceRequest.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