com.amazonaws.services.redshift.model.DescribeDataSharesRequest Maven / Gradle / Ivy
Show all versions of aws-java-sdk-redshift Show documentation
/*
* Copyright 2019-2024 Amazon.com, Inc. or its affiliates. All Rights Reserved.
*
* Licensed under the Apache License, Version 2.0 (the "License"). You may not use this file except in compliance with
* the License. A copy of the License is located at
*
* http://aws.amazon.com/apache2.0
*
* or in the "license" file accompanying this file. This file is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR
* CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions
* and limitations under the License.
*/
package com.amazonaws.services.redshift.model;
import java.io.Serializable;
import javax.annotation.Generated;
import com.amazonaws.AmazonWebServiceRequest;
/**
*
* @see AWS API
* Documentation
*/
@Generated("com.amazonaws:aws-java-sdk-code-generator")
public class DescribeDataSharesRequest extends com.amazonaws.AmazonWebServiceRequest implements Serializable, Cloneable {
/**
*
* The Amazon resource name (ARN) of the datashare to describe details of.
*
*/
private String dataShareArn;
/**
*
* 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.
*
*/
private Integer maxRecords;
/**
*
* An optional parameter that specifies the starting point to return a set of response records. When the results of
* a DescribeDataShares 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.
*
*/
private String marker;
/**
*
* The Amazon resource name (ARN) of the datashare to describe details of.
*
*
* @param dataShareArn
* The Amazon resource name (ARN) of the datashare to describe details of.
*/
public void setDataShareArn(String dataShareArn) {
this.dataShareArn = dataShareArn;
}
/**
*
* The Amazon resource name (ARN) of the datashare to describe details of.
*
*
* @return The Amazon resource name (ARN) of the datashare to describe details of.
*/
public String getDataShareArn() {
return this.dataShareArn;
}
/**
*
* The Amazon resource name (ARN) of the datashare to describe details of.
*
*
* @param dataShareArn
* The Amazon resource name (ARN) of the datashare to describe details of.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public DescribeDataSharesRequest withDataShareArn(String dataShareArn) {
setDataShareArn(dataShareArn);
return this;
}
/**
*
* 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.
*
*
* @param 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.
*/
public void setMaxRecords(Integer maxRecords) {
this.maxRecords = 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.
*
*
* @return 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.
*/
public Integer getMaxRecords() {
return this.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.
*
*
* @param 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.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public DescribeDataSharesRequest withMaxRecords(Integer maxRecords) {
setMaxRecords(maxRecords);
return this;
}
/**
*
* An optional parameter that specifies the starting point to return a set of response records. When the results of
* a DescribeDataShares 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.
*
*
* @param marker
* An optional parameter that specifies the starting point to return a set of response records. When the
* results of a DescribeDataShares 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.
*/
public void setMarker(String marker) {
this.marker = marker;
}
/**
*
* An optional parameter that specifies the starting point to return a set of response records. When the results of
* a DescribeDataShares 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.
*
*
* @return An optional parameter that specifies the starting point to return a set of response records. When the
* results of a DescribeDataShares 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.
*/
public String getMarker() {
return this.marker;
}
/**
*
* An optional parameter that specifies the starting point to return a set of response records. When the results of
* a DescribeDataShares 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.
*
*
* @param marker
* An optional parameter that specifies the starting point to return a set of response records. When the
* results of a DescribeDataShares 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.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public DescribeDataSharesRequest withMarker(String marker) {
setMarker(marker);
return this;
}
/**
* 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.
*
* @return A string representation of this object.
*
* @see java.lang.Object#toString()
*/
@Override
public String toString() {
StringBuilder sb = new StringBuilder();
sb.append("{");
if (getDataShareArn() != null)
sb.append("DataShareArn: ").append(getDataShareArn()).append(",");
if (getMaxRecords() != null)
sb.append("MaxRecords: ").append(getMaxRecords()).append(",");
if (getMarker() != null)
sb.append("Marker: ").append(getMarker());
sb.append("}");
return sb.toString();
}
@Override
public boolean equals(Object obj) {
if (this == obj)
return true;
if (obj == null)
return false;
if (obj instanceof DescribeDataSharesRequest == false)
return false;
DescribeDataSharesRequest other = (DescribeDataSharesRequest) obj;
if (other.getDataShareArn() == null ^ this.getDataShareArn() == null)
return false;
if (other.getDataShareArn() != null && other.getDataShareArn().equals(this.getDataShareArn()) == false)
return false;
if (other.getMaxRecords() == null ^ this.getMaxRecords() == null)
return false;
if (other.getMaxRecords() != null && other.getMaxRecords().equals(this.getMaxRecords()) == false)
return false;
if (other.getMarker() == null ^ this.getMarker() == null)
return false;
if (other.getMarker() != null && other.getMarker().equals(this.getMarker()) == false)
return false;
return true;
}
@Override
public int hashCode() {
final int prime = 31;
int hashCode = 1;
hashCode = prime * hashCode + ((getDataShareArn() == null) ? 0 : getDataShareArn().hashCode());
hashCode = prime * hashCode + ((getMaxRecords() == null) ? 0 : getMaxRecords().hashCode());
hashCode = prime * hashCode + ((getMarker() == null) ? 0 : getMarker().hashCode());
return hashCode;
}
@Override
public DescribeDataSharesRequest clone() {
return (DescribeDataSharesRequest) super.clone();
}
}