Package software.amazon.awssdk.services.redshift.model

Class DescribeDataSharesForConsumerRequest

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

  • Method Details

    • consumerArn

      public final String consumerArn()

      The Amazon Resource Name (ARN) of the consumer namespace that returns in the list of datashares.

      Returns:
      The Amazon Resource Name (ARN) of the consumer namespace that returns in the list of datashares.

    • status

      public final DataShareStatusForConsumer status()

      An identifier giving the status of a datashare in the consumer cluster. If this field is specified, Amazon Redshift returns the list of datashares that have the specified status.

      If the service returns an enum value that is not available in the current SDK version, status will return DataShareStatusForConsumer.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from statusAsString().

      Returns:
      An identifier giving the status of a datashare in the consumer cluster. If this field is specified, Amazon Redshift returns the list of datashares that have the specified status.
      See Also:

    • statusAsString

      public final String statusAsString()

      An identifier giving the status of a datashare in the consumer cluster. If this field is specified, Amazon Redshift returns the list of datashares that have the specified status.

      If the service returns an enum value that is not available in the current SDK version, status will return DataShareStatusForConsumer.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from statusAsString().

      Returns:
      An identifier giving the status of a datashare in the consumer cluster. If this field is specified, Amazon Redshift returns the list of datashares that have the specified status.
      See Also:

    • maxRecords

      public final Integer maxRecords()

      The maximum number of response records to return in each call. If the number of remaining response records exceeds the specified MaxRecords value, a value is returned in a marker field of the response. You can retrieve the next set of records by retrying the command with the returned marker value.

      Returns:
      The maximum number of response records to return in each call. If the number of remaining response records exceeds the specified MaxRecords value, a value is returned in a marker field of the response. You can retrieve the next set of records by retrying the command with the returned marker value.

    • marker

      public final String marker()

      An optional parameter that specifies the starting point to return a set of response records. When the results of a DescribeDataSharesForConsumer request exceed the value specified in MaxRecords, Amazon Web Services returns a value in the Marker field of the response. You can retrieve the next set of response records by providing the returned marker value in the Marker parameter and retrying the request.

      Returns:
      An optional parameter that specifies the starting point to return a set of response records. When the results of a DescribeDataSharesForConsumer request exceed the value specified in MaxRecords, Amazon Web Services returns a value in the Marker field of the response. You can retrieve the next set of response records by providing the returned marker value in the Marker parameter and retrying the request.

    • toBuilder

      public DescribeDataSharesForConsumerRequest.Builder toBuilder()
      Description copied from interface: ToCopyableBuilder
      Take this object and create a builder that contains all of the current property values of this object.
      Specified by:
      toBuilder in interface ToCopyableBuilder<DescribeDataSharesForConsumerRequest.Builder,DescribeDataSharesForConsumerRequest>
      Specified by:
      toBuilder in class RedshiftRequest
      Returns:
      a builder for type T

    • builder

      public static DescribeDataSharesForConsumerRequest.Builder builder()

    • serializableBuilderClass

      public static Class<? extends DescribeDataSharesForConsumerRequest.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)
      Description copied from interface: SdkPojo
      Indicates whether some other object is "equal to" this one by SDK fields. An SDK field is a modeled, non-inherited field in an SdkPojo class, and is generated based on a service model.

      If an SdkPojo class does not have any inherited fields, equalsBySdkFields and equals are essentially the same.

      Specified by:
      equalsBySdkFields in interface SdkPojo
      Parameters:
      obj - the object to be compared with
      Returns:
      true if the other object equals to this object by sdk fields, false otherwise.

    • 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)
      Description copied from class: SdkRequest
      Used to retrieve the value of a field from any class that extends SdkRequest. 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, the SdkRequest.getValueForField(String, Class) method will again be available.
      Overrides:
      getValueForField in class SdkRequest
      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

      public final List<SdkField<?>> sdkFields()
      Specified by:
      sdkFields in interface SdkPojo
      Returns:
      List of SdkField in this POJO. May be empty list but should never be null.