Start line:  
End line:  

Snippet Preview

Snippet HTML Code

Stack Overflow Questions
  /*
   * Copyright 2010-2015 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;
 
 
Container for the parameters to the DescribeTags operation.

Returns a list of tags. You can return tags from a specific resource by specifying an ARN, or you can return all tags for a given type of resource, such as clusters, snapshots, and so on.

The following are limitations for DescribeTags :

  • You cannot specify an ARN and a resource-type value together in the same request.
  • You cannot use the MaxRecords and Marker parameters together with the ARN parameter.
  • The MaxRecords parameter can be a range from 10 to 50 results to return in a request.

If you specify both tag keys and tag values in the same request, Amazon Redshift returns all resources that match any combination of the specified keys and values. For example, if you have owner and environment for tag keys, and admin and test for tag values, all resources that have any combination of those values are returned.

If both tag keys and values are omitted from the request, resources are returned regardless of whether they have tag keys or values associated with them.

 
 public class DescribeTagsRequest extends AmazonWebServiceRequest implements SerializableCloneable {

    
The Amazon Resource Name (ARN) for which you want to describe the tag or tags. For example, arn:aws:redshift:us-east-1:123456789:cluster:t1.
 
     private String resourceName;

    
The type of resource with which you want to view tags. Valid resource types are:
  • Cluster
  • CIDR/IP
  • EC2 security group
  • Snapshot
  • Cluster security group
  • Subnet group
  • HSM connection
  • HSM certificate
  • Parameter group

For more information about Amazon Redshift resource types and constructing ARNs, go to Constructing an Amazon Redshift Amazon Resource Name (ARN) in the Amazon Redshift Cluster Management Guide.

 
     private String resourceType;

    
The maximum number or 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;

    
A value that indicates the starting point for the next set of response records in a subsequent request. If a value is returned in a response, you can retrieve the next set of records by providing this returned marker value in the marker parameter and retrying the command. If the marker field is empty, all response records have been retrieved for the request.
 
     private String marker;

    
A tag key or keys for which you want to return all matching resources that are associated with the specified key or keys. For example, suppose that you have resources tagged with keys called owner and environment. If you specify both of these tag keys in the request, Amazon Redshift returns a response with all resources that have either or both of these tag keys associated with them.
A tag value or values for which you want to return all matching resources that are associated with the specified value or values. For example, suppose that you have resources tagged with values called admin and test. If you specify both of these tag values in the request, Amazon Redshift returns a response with all resources that have either or both of these tag values associated with them.
The Amazon Resource Name (ARN) for which you want to describe the tag or tags. For example, arn:aws:redshift:us-east-1:123456789:cluster:t1.

Returns:
The Amazon Resource Name (ARN) for which you want to describe the tag or tags. For example, arn:aws:redshift:us-east-1:123456789:cluster:t1.
    public String getResourceName() {
        return ;
    }
    
    
The Amazon Resource Name (ARN) for which you want to describe the tag or tags. For example, arn:aws:redshift:us-east-1:123456789:cluster:t1.

Parameters:
resourceName The Amazon Resource Name (ARN) for which you want to describe the tag or tags. For example, arn:aws:redshift:us-east-1:123456789:cluster:t1.
    public void setResourceName(String resourceName) {
        this. = resourceName;
    }
    
    
The Amazon Resource Name (ARN) for which you want to describe the tag or tags. For example, arn:aws:redshift:us-east-1:123456789:cluster:t1.

Returns a reference to this object so that method calls can be chained together.

Parameters:
resourceName The Amazon Resource Name (ARN) for which you want to describe the tag or tags. For example, arn:aws:redshift:us-east-1:123456789:cluster:t1.
Returns:
A reference to this updated object so that method calls can be chained together.
    public DescribeTagsRequest withResourceName(String resourceName) {
        this. = resourceName;
        return this;
    }

    
The type of resource with which you want to view tags. Valid resource types are:
  • Cluster
  • CIDR/IP
  • EC2 security group
  • Snapshot
  • Cluster security group
  • Subnet group
  • HSM connection
  • HSM certificate
  • Parameter group

For more information about Amazon Redshift resource types and constructing ARNs, go to Constructing an Amazon Redshift Amazon Resource Name (ARN) in the Amazon Redshift Cluster Management Guide.

Returns:
The type of resource with which you want to view tags. Valid resource types are:
  • Cluster
  • CIDR/IP
  • EC2 security group
  • Snapshot
  • Cluster security group
  • Subnet group
  • HSM connection
  • HSM certificate
  • Parameter group

For more information about Amazon Redshift resource types and constructing ARNs, go to Constructing an Amazon Redshift Amazon Resource Name (ARN) in the Amazon Redshift Cluster Management Guide.

    public String getResourceType() {
        return ;
    }
    
    
The type of resource with which you want to view tags. Valid resource types are:
  • Cluster
  • CIDR/IP
  • EC2 security group
  • Snapshot
  • Cluster security group
  • Subnet group
  • HSM connection
  • HSM certificate
  • Parameter group

For more information about Amazon Redshift resource types and constructing ARNs, go to Constructing an Amazon Redshift Amazon Resource Name (ARN) in the Amazon Redshift Cluster Management Guide.

Parameters:
resourceType The type of resource with which you want to view tags. Valid resource types are:
  • Cluster
  • CIDR/IP
  • EC2 security group
  • Snapshot
  • Cluster security group
  • Subnet group
  • HSM connection
  • HSM certificate
  • Parameter group

For more information about Amazon Redshift resource types and constructing ARNs, go to Constructing an Amazon Redshift Amazon Resource Name (ARN) in the Amazon Redshift Cluster Management Guide.

    public void setResourceType(String resourceType) {
        this. = resourceType;
    }
    
    
The type of resource with which you want to view tags. Valid resource types are:
  • Cluster
  • CIDR/IP
  • EC2 security group
  • Snapshot
  • Cluster security group
  • Subnet group
  • HSM connection
  • HSM certificate
  • Parameter group

For more information about Amazon Redshift resource types and constructing ARNs, go to Constructing an Amazon Redshift Amazon Resource Name (ARN) in the Amazon Redshift Cluster Management Guide.

Returns a reference to this object so that method calls can be chained together.

Parameters:
resourceType The type of resource with which you want to view tags. Valid resource types are:
  • Cluster
  • CIDR/IP
  • EC2 security group
  • Snapshot
  • Cluster security group
  • Subnet group
  • HSM connection
  • HSM certificate
  • Parameter group

For more information about Amazon Redshift resource types and constructing ARNs, go to Constructing an Amazon Redshift Amazon Resource Name (ARN) in the Amazon Redshift Cluster Management Guide.

Returns:
A reference to this updated object so that method calls can be chained together.
    public DescribeTagsRequest withResourceType(String resourceType) {
        this. = resourceType;
        return this;
    }

    
The maximum number or 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 or 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 ;
    }
    
    
The maximum number or 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.

Parameters:
maxRecords The maximum number or 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;
    }
    
    
The maximum number or 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 a reference to this object so that method calls can be chained together.

Parameters:
maxRecords The maximum number or 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:
A reference to this updated object so that method calls can be chained together.
    public DescribeTagsRequest withMaxRecords(Integer maxRecords) {
        this. = maxRecords;
        return this;
    }

    
A value that indicates the starting point for the next set of response records in a subsequent request. If a value is returned in a response, you can retrieve the next set of records by providing this returned marker value in the marker parameter and retrying the command. If the marker field is empty, all response records have been retrieved for the request.

Returns:
A value that indicates the starting point for the next set of response records in a subsequent request. If a value is returned in a response, you can retrieve the next set of records by providing this returned marker value in the marker parameter and retrying the command. If the marker field is empty, all response records have been retrieved for the request.
    public String getMarker() {
        return ;
    }
    
    
A value that indicates the starting point for the next set of response records in a subsequent request. If a value is returned in a response, you can retrieve the next set of records by providing this returned marker value in the marker parameter and retrying the command. If the marker field is empty, all response records have been retrieved for the request.

Parameters:
marker A value that indicates the starting point for the next set of response records in a subsequent request. If a value is returned in a response, you can retrieve the next set of records by providing this returned marker value in the marker parameter and retrying the command. If the marker field is empty, all response records have been retrieved for the request.
    public void setMarker(String marker) {
        this. = marker;
    }
    
    
A value that indicates the starting point for the next set of response records in a subsequent request. If a value is returned in a response, you can retrieve the next set of records by providing this returned marker value in the marker parameter and retrying the command. If the marker field is empty, all response records have been retrieved for the request.

Returns a reference to this object so that method calls can be chained together.

Parameters:
marker A value that indicates the starting point for the next set of response records in a subsequent request. If a value is returned in a response, you can retrieve the next set of records by providing this returned marker value in the marker parameter and retrying the command. If the marker field is empty, all response records have been retrieved for the request.
Returns:
A reference to this updated object so that method calls can be chained together.
    public DescribeTagsRequest withMarker(String marker) {
        this. = marker;
        return this;
    }

    
A tag key or keys for which you want to return all matching resources that are associated with the specified key or keys. For example, suppose that you have resources tagged with keys called owner and environment. If you specify both of these tag keys in the request, Amazon Redshift returns a response with all resources that have either or both of these tag keys associated with them.

Returns:
A tag key or keys for which you want to return all matching resources that are associated with the specified key or keys. For example, suppose that you have resources tagged with keys called owner and environment. If you specify both of these tag keys in the request, Amazon Redshift returns a response with all resources that have either or both of these tag keys associated with them.
    public java.util.List<StringgetTagKeys() {
        if ( == null) {
               = new com.amazonaws.internal.ListWithAutoConstructFlag<String>();
              .setAutoConstruct(true);
        }
        return ;
    }
    
    
A tag key or keys for which you want to return all matching resources that are associated with the specified key or keys. For example, suppose that you have resources tagged with keys called owner and environment. If you specify both of these tag keys in the request, Amazon Redshift returns a response with all resources that have either or both of these tag keys associated with them.

Parameters:
tagKeys A tag key or keys for which you want to return all matching resources that are associated with the specified key or keys. For example, suppose that you have resources tagged with keys called owner and environment. If you specify both of these tag keys in the request, Amazon Redshift returns a response with all resources that have either or both of these tag keys associated with them.
    public void setTagKeys(java.util.Collection<StringtagKeys) {
        if (tagKeys == null) {
            this. = null;
            return;
        }
        tagKeysCopy.addAll(tagKeys);
        this. = tagKeysCopy;
    }
    
    
A tag key or keys for which you want to return all matching resources that are associated with the specified key or keys. For example, suppose that you have resources tagged with keys called owner and environment. If you specify both of these tag keys in the request, Amazon Redshift returns a response with all resources that have either or both of these tag keys associated with them.

NOTE: This method appends the values to the existing list (if any). Use setTagKeys(java.util.Collection) or withTagKeys(java.util.Collection) if you want to override the existing values.

Returns a reference to this object so that method calls can be chained together.

Parameters:
tagKeys A tag key or keys for which you want to return all matching resources that are associated with the specified key or keys. For example, suppose that you have resources tagged with keys called owner and environment. If you specify both of these tag keys in the request, Amazon Redshift returns a response with all resources that have either or both of these tag keys associated with them.
Returns:
A reference to this updated object so that method calls can be chained together.
    public DescribeTagsRequest withTagKeys(String... tagKeys) {
        if (getTagKeys() == nullsetTagKeys(new java.util.ArrayList<String>(tagKeys.length));
        for (String value : tagKeys) {
            getTagKeys().add(value);
        }
        return this;
    }
    
    
A tag key or keys for which you want to return all matching resources that are associated with the specified key or keys. For example, suppose that you have resources tagged with keys called owner and environment. If you specify both of these tag keys in the request, Amazon Redshift returns a response with all resources that have either or both of these tag keys associated with them.

Returns a reference to this object so that method calls can be chained together.

Parameters:
tagKeys A tag key or keys for which you want to return all matching resources that are associated with the specified key or keys. For example, suppose that you have resources tagged with keys called owner and environment. If you specify both of these tag keys in the request, Amazon Redshift returns a response with all resources that have either or both of these tag keys associated with them.
Returns:
A reference to this updated object so that method calls can be chained together.
        if (tagKeys == null) {
            this. = null;
        } else {
            tagKeysCopy.addAll(tagKeys);
            this. = tagKeysCopy;
        }
        return this;
    }

    
A tag value or values for which you want to return all matching resources that are associated with the specified value or values. For example, suppose that you have resources tagged with values called admin and test. If you specify both of these tag values in the request, Amazon Redshift returns a response with all resources that have either or both of these tag values associated with them.

Returns:
A tag value or values for which you want to return all matching resources that are associated with the specified value or values. For example, suppose that you have resources tagged with values called admin and test. If you specify both of these tag values in the request, Amazon Redshift returns a response with all resources that have either or both of these tag values associated with them.
    public java.util.List<StringgetTagValues() {
        if ( == null) {
               = new com.amazonaws.internal.ListWithAutoConstructFlag<String>();
              .setAutoConstruct(true);
        }
        return ;
    }
    
    
A tag value or values for which you want to return all matching resources that are associated with the specified value or values. For example, suppose that you have resources tagged with values called admin and test. If you specify both of these tag values in the request, Amazon Redshift returns a response with all resources that have either or both of these tag values associated with them.

Parameters:
tagValues A tag value or values for which you want to return all matching resources that are associated with the specified value or values. For example, suppose that you have resources tagged with values called admin and test. If you specify both of these tag values in the request, Amazon Redshift returns a response with all resources that have either or both of these tag values associated with them.
    public void setTagValues(java.util.Collection<StringtagValues) {
        if (tagValues == null) {
            this. = null;
            return;
        }
        tagValuesCopy.addAll(tagValues);
        this. = tagValuesCopy;
    }
    
    
A tag value or values for which you want to return all matching resources that are associated with the specified value or values. For example, suppose that you have resources tagged with values called admin and test. If you specify both of these tag values in the request, Amazon Redshift returns a response with all resources that have either or both of these tag values associated with them.

NOTE: This method appends the values to the existing list (if any). Use setTagValues(java.util.Collection) or withTagValues(java.util.Collection) if you want to override the existing values.

Returns a reference to this object so that method calls can be chained together.

Parameters:
tagValues A tag value or values for which you want to return all matching resources that are associated with the specified value or values. For example, suppose that you have resources tagged with values called admin and test. If you specify both of these tag values in the request, Amazon Redshift returns a response with all resources that have either or both of these tag values associated with them.
Returns:
A reference to this updated object so that method calls can be chained together.
    public DescribeTagsRequest withTagValues(String... tagValues) {
        if (getTagValues() == nullsetTagValues(new java.util.ArrayList<String>(tagValues.length));
        for (String value : tagValues) {
            getTagValues().add(value);
        }
        return this;
    }
    
    
A tag value or values for which you want to return all matching resources that are associated with the specified value or values. For example, suppose that you have resources tagged with values called admin and test. If you specify both of these tag values in the request, Amazon Redshift returns a response with all resources that have either or both of these tag values associated with them.

Returns a reference to this object so that method calls can be chained together.

Parameters:
tagValues A tag value or values for which you want to return all matching resources that are associated with the specified value or values. For example, suppose that you have resources tagged with values called admin and test. If you specify both of these tag values in the request, Amazon Redshift returns a response with all resources that have either or both of these tag values associated with them.
Returns:
A reference to this updated object so that method calls can be chained together.
        if (tagValues == null) {
            this. = null;
        } else {
            com.amazonaws.internal.ListWithAutoConstructFlag<StringtagValuesCopy = new com.amazonaws.internal.ListWithAutoConstructFlag<String>(tagValues.size());
            tagValuesCopy.addAll(tagValues);
            this. = tagValuesCopy;
        }
        return this;
    }

    
Returns a string representation of this object; useful for testing and debugging.

Returns:
A string representation of this object.
See also:
java.lang.Object.toString()
    @Override
    public String toString() {
        StringBuilder sb = new StringBuilder();
        sb.append("{");
        if (getResourceName() != nullsb.append("ResourceName: " + getResourceName() + ",");
        if (getResourceType() != nullsb.append("ResourceType: " + getResourceType() + ",");
        if (getMaxRecords() != nullsb.append("MaxRecords: " + getMaxRecords() + ",");
        if (getMarker() != nullsb.append("Marker: " + getMarker() + ",");
        if (getTagKeys() != nullsb.append("TagKeys: " + getTagKeys() + ",");
        if (getTagValues() != nullsb.append("TagValues: " + getTagValues() );
        sb.append("}");
        return sb.toString();
    }
    
    @Override
    public int hashCode() {
        final int prime = 31;
        int hashCode = 1;
        
        hashCode = prime * hashCode + ((getResourceName() == null) ? 0 : getResourceName().hashCode()); 
        hashCode = prime * hashCode + ((getResourceType() == null) ? 0 : getResourceType().hashCode()); 
        hashCode = prime * hashCode + ((getMaxRecords() == null) ? 0 : getMaxRecords().hashCode()); 
        hashCode = prime * hashCode + ((getMarker() == null) ? 0 : getMarker().hashCode()); 
        hashCode = prime * hashCode + ((getTagKeys() == null) ? 0 : getTagKeys().hashCode()); 
        hashCode = prime * hashCode + ((getTagValues() == null) ? 0 : getTagValues().hashCode()); 
        return hashCode;
    }
    
    @Override
    public boolean equals(Object obj) {
        if (this == objreturn true;
        if (obj == nullreturn false;
        if (obj instanceof DescribeTagsRequest == falsereturn false;
        DescribeTagsRequest other = (DescribeTagsRequest)obj;
        
        if (other.getResourceName() == null ^ this.getResourceName() == nullreturn false;
        if (other.getResourceName() != null && other.getResourceName().equals(this.getResourceName()) == falsereturn false
        if (other.getResourceType() == null ^ this.getResourceType() == nullreturn false;
        if (other.getResourceType() != null && other.getResourceType().equals(this.getResourceType()) == falsereturn false
        if (other.getMaxRecords() == null ^ this.getMaxRecords() == nullreturn false;
        if (other.getMaxRecords() != null && other.getMaxRecords().equals(this.getMaxRecords()) == falsereturn false
        if (other.getMarker() == null ^ this.getMarker() == nullreturn false;
        if (other.getMarker() != null && other.getMarker().equals(this.getMarker()) == falsereturn false
        if (other.getTagKeys() == null ^ this.getTagKeys() == nullreturn false;
        if (other.getTagKeys() != null && other.getTagKeys().equals(this.getTagKeys()) == falsereturn false
        if (other.getTagValues() == null ^ this.getTagValues() == nullreturn false;
        if (other.getTagValues() != null && other.getTagValues().equals(this.getTagValues()) == falsereturn false
        return true;
    }
    
    @Override
    public DescribeTagsRequest clone() {
        
            return (DescribeTagsRequestsuper.clone();
    }
}
    
New to GrepCode? Check out our FAQ X