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>

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	DescribeDataSharesForConsumerRequest.Builder

Method Summary

Modifier and Type	Method	Description
static DescribeDataSharesForConsumerRequest.Builder	builder()
String	consumerArn()	The Amazon Resource Name (ARN) of the consumer that returns in the list of datashares.
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
int	hashCode()
String	marker()	An optional parameter that specifies the starting point to return a set of response records.
Integer	maxRecords()	The maximum number of response records to return in each call.
List<SdkField<?>>	sdkFields()
static Class<? extends DescribeDataSharesForConsumerRequest.Builder>	serializableBuilderClass()
DataShareStatusForConsumer	status()	An identifier giving the status of a datashare in the consumer cluster.
String	statusAsString()	An identifier giving the status of a datashare in the consumer cluster.
DescribeDataSharesForConsumerRequest.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

consumerArn

public final String consumerArn()

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

Returns:

The Amazon Resource Name (ARN) of the consumer 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:

DataShareStatusForConsumer

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:

DataShareStatusForConsumer

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()

Specified by:

toBuilder in interface ToCopyableBuilder<DescribeDataSharesForConsumerRequest.Builder,DescribeDataSharesForConsumerRequest>

Specified by:

toBuilder in class RedshiftRequest

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)

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