com.amazonaws.services.resourceexplorer2.model.UpdateViewRequest Maven / Gradle / Ivy
Show all versions of aws-java-sdk-resourceexplorer2 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.resourceexplorer2.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 UpdateViewRequest extends com.amazonaws.AmazonWebServiceRequest implements Serializable, Cloneable {
/**
*
* An array of strings that specify which resources are included in the results of queries made using this view.
* When you use this view in a Search operation, the filter string is combined with the search's
* QueryString parameter using a logical AND operator.
*
*
* For information about the supported syntax, see Search query
* reference for Resource Explorer in the Amazon Web Services Resource Explorer User Guide.
*
*
*
* This query string in the context of this operation supports only filter prefixes with optional operators. It doesn't support free-form text. For example, the string
* region:us* service:ec2 -tag:stage=prod includes all Amazon EC2 resources in any Amazon Web Services
* Region that begins with the letters us and is not tagged with a key Stage that
* has the value prod.
*
*
*/
private SearchFilter filters;
/**
*
* Specifies optional fields that you want included in search results from this view. It is a list of objects that
* each describe a field to include.
*
*
* The default is an empty list, with no optional fields included in the results.
*
*/
private java.util.List includedProperties;
/**
*
* The Amazon resource name
* (ARN) of the view that you want to modify.
*
*/
private String viewArn;
/**
*
* An array of strings that specify which resources are included in the results of queries made using this view.
* When you use this view in a Search operation, the filter string is combined with the search's
* QueryString parameter using a logical AND operator.
*
*
* For information about the supported syntax, see Search query
* reference for Resource Explorer in the Amazon Web Services Resource Explorer User Guide.
*
*
*
* This query string in the context of this operation supports only filter prefixes with optional operators. It doesn't support free-form text. For example, the string
* region:us* service:ec2 -tag:stage=prod includes all Amazon EC2 resources in any Amazon Web Services
* Region that begins with the letters us and is not tagged with a key Stage that
* has the value prod.
*
*
*
* @param filters
* An array of strings that specify which resources are included in the results of queries made using this
* view. When you use this view in a Search operation, the filter string is combined with the search's
* QueryString parameter using a logical AND operator.
*
* For information about the supported syntax, see Search query reference for Resource Explorer in the Amazon Web Services Resource Explorer User
* Guide.
*
*
*
* This query string in the context of this operation supports only filter prefixes with optional operators. It doesn't support free-form text. For example, the string
* region:us* service:ec2 -tag:stage=prod includes all Amazon EC2 resources in any Amazon Web
* Services Region that begins with the letters us and is not tagged with a key
* Stage that has the value prod.
*
*/
public void setFilters(SearchFilter filters) {
this.filters = filters;
}
/**
*
* An array of strings that specify which resources are included in the results of queries made using this view.
* When you use this view in a Search operation, the filter string is combined with the search's
* QueryString parameter using a logical AND operator.
*
*
* For information about the supported syntax, see Search query
* reference for Resource Explorer in the Amazon Web Services Resource Explorer User Guide.
*
*
*
* This query string in the context of this operation supports only filter prefixes with optional operators. It doesn't support free-form text. For example, the string
* region:us* service:ec2 -tag:stage=prod includes all Amazon EC2 resources in any Amazon Web Services
* Region that begins with the letters us and is not tagged with a key Stage that
* has the value prod.
*
*
*
* @return An array of strings that specify which resources are included in the results of queries made using this
* view. When you use this view in a Search operation, the filter string is combined with the
* search's QueryString parameter using a logical AND operator.
*
* For information about the supported syntax, see Search query reference for Resource Explorer in the Amazon Web Services Resource Explorer User
* Guide.
*
*
*
* This query string in the context of this operation supports only filter prefixes with optional operators. It doesn't support free-form text. For example, the string
* region:us* service:ec2 -tag:stage=prod includes all Amazon EC2 resources in any Amazon Web
* Services Region that begins with the letters us and is not tagged with a key
* Stage that has the value prod.
*
*/
public SearchFilter getFilters() {
return this.filters;
}
/**
*
* An array of strings that specify which resources are included in the results of queries made using this view.
* When you use this view in a Search operation, the filter string is combined with the search's
* QueryString parameter using a logical AND operator.
*
*
* For information about the supported syntax, see Search query
* reference for Resource Explorer in the Amazon Web Services Resource Explorer User Guide.
*
*
*
* This query string in the context of this operation supports only filter prefixes with optional operators. It doesn't support free-form text. For example, the string
* region:us* service:ec2 -tag:stage=prod includes all Amazon EC2 resources in any Amazon Web Services
* Region that begins with the letters us and is not tagged with a key Stage that
* has the value prod.
*
*
*
* @param filters
* An array of strings that specify which resources are included in the results of queries made using this
* view. When you use this view in a Search operation, the filter string is combined with the search's
* QueryString parameter using a logical AND operator.
*
* For information about the supported syntax, see Search query reference for Resource Explorer in the Amazon Web Services Resource Explorer User
* Guide.
*
*
*
* This query string in the context of this operation supports only filter prefixes with optional operators. It doesn't support free-form text. For example, the string
* region:us* service:ec2 -tag:stage=prod includes all Amazon EC2 resources in any Amazon Web
* Services Region that begins with the letters us and is not tagged with a key
* Stage that has the value prod.
*
* @return Returns a reference to this object so that method calls can be chained together.
*/
public UpdateViewRequest withFilters(SearchFilter filters) {
setFilters(filters);
return this;
}
/**
*
* Specifies optional fields that you want included in search results from this view. It is a list of objects that
* each describe a field to include.
*
*
* The default is an empty list, with no optional fields included in the results.
*
*
* @return Specifies optional fields that you want included in search results from this view. It is a list of
* objects that each describe a field to include.
*
* The default is an empty list, with no optional fields included in the results.
*/
public java.util.List getIncludedProperties() {
return includedProperties;
}
/**
*
* Specifies optional fields that you want included in search results from this view. It is a list of objects that
* each describe a field to include.
*
*
* The default is an empty list, with no optional fields included in the results.
*
*
* @param includedProperties
* Specifies optional fields that you want included in search results from this view. It is a list of objects
* that each describe a field to include.
*
* The default is an empty list, with no optional fields included in the results.
*/
public void setIncludedProperties(java.util.Collection includedProperties) {
if (includedProperties == null) {
this.includedProperties = null;
return;
}
this.includedProperties = new java.util.ArrayList(includedProperties);
}
/**
*
* Specifies optional fields that you want included in search results from this view. It is a list of objects that
* each describe a field to include.
*
*
* The default is an empty list, with no optional fields included in the results.
*
*
* NOTE: This method appends the values to the existing list (if any). Use
* {@link #setIncludedProperties(java.util.Collection)} or {@link #withIncludedProperties(java.util.Collection)} if
* you want to override the existing values.
*
*
* @param includedProperties
* Specifies optional fields that you want included in search results from this view. It is a list of objects
* that each describe a field to include.
*
* The default is an empty list, with no optional fields included in the results.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public UpdateViewRequest withIncludedProperties(IncludedProperty... includedProperties) {
if (this.includedProperties == null) {
setIncludedProperties(new java.util.ArrayList(includedProperties.length));
}
for (IncludedProperty ele : includedProperties) {
this.includedProperties.add(ele);
}
return this;
}
/**
*
* Specifies optional fields that you want included in search results from this view. It is a list of objects that
* each describe a field to include.
*
*
* The default is an empty list, with no optional fields included in the results.
*
*
* @param includedProperties
* Specifies optional fields that you want included in search results from this view. It is a list of objects
* that each describe a field to include.
*
* The default is an empty list, with no optional fields included in the results.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public UpdateViewRequest withIncludedProperties(java.util.Collection includedProperties) {
setIncludedProperties(includedProperties);
return this;
}
/**
*
* The Amazon resource name
* (ARN) of the view that you want to modify.
*
*
* @param viewArn
* The Amazon resource
* name (ARN) of the view that you want to modify.
*/
public void setViewArn(String viewArn) {
this.viewArn = viewArn;
}
/**
*
* The Amazon resource name
* (ARN) of the view that you want to modify.
*
*
* @return The Amazon resource
* name (ARN) of the view that you want to modify.
*/
public String getViewArn() {
return this.viewArn;
}
/**
*
* The Amazon resource name
* (ARN) of the view that you want to modify.
*
*
* @param viewArn
* The Amazon resource
* name (ARN) of the view that you want to modify.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public UpdateViewRequest withViewArn(String viewArn) {
setViewArn(viewArn);
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 (getFilters() != null)
sb.append("Filters: ").append("***Sensitive Data Redacted***").append(",");
if (getIncludedProperties() != null)
sb.append("IncludedProperties: ").append(getIncludedProperties()).append(",");
if (getViewArn() != null)
sb.append("ViewArn: ").append(getViewArn());
sb.append("}");
return sb.toString();
}
@Override
public boolean equals(Object obj) {
if (this == obj)
return true;
if (obj == null)
return false;
if (obj instanceof UpdateViewRequest == false)
return false;
UpdateViewRequest other = (UpdateViewRequest) obj;
if (other.getFilters() == null ^ this.getFilters() == null)
return false;
if (other.getFilters() != null && other.getFilters().equals(this.getFilters()) == false)
return false;
if (other.getIncludedProperties() == null ^ this.getIncludedProperties() == null)
return false;
if (other.getIncludedProperties() != null && other.getIncludedProperties().equals(this.getIncludedProperties()) == false)
return false;
if (other.getViewArn() == null ^ this.getViewArn() == null)
return false;
if (other.getViewArn() != null && other.getViewArn().equals(this.getViewArn()) == false)
return false;
return true;
}
@Override
public int hashCode() {
final int prime = 31;
int hashCode = 1;
hashCode = prime * hashCode + ((getFilters() == null) ? 0 : getFilters().hashCode());
hashCode = prime * hashCode + ((getIncludedProperties() == null) ? 0 : getIncludedProperties().hashCode());
hashCode = prime * hashCode + ((getViewArn() == null) ? 0 : getViewArn().hashCode());
return hashCode;
}
@Override
public UpdateViewRequest clone() {
return (UpdateViewRequest) super.clone();
}
}