software.amazon.awssdk.services.resourceexplorer2.model

Class UpdateViewRequest

java.lang.Object

software.amazon.awssdk.core.SdkRequest

software.amazon.awssdk.awscore.AwsRequest

software.amazon.awssdk.services.resourceexplorer2.model.ResourceExplorer2Request

software.amazon.awssdk.services.resourceexplorer2.model.UpdateViewRequest

All Implemented Interfaces:

SdkPojo, ToCopyableBuilder<UpdateViewRequest.Builder,UpdateViewRequest>

@Generated(value="software.amazon.awssdk:codegen")
public final class UpdateViewRequest
extends ResourceExplorer2Request
implements ToCopyableBuilder<UpdateViewRequest.Builder,UpdateViewRequest>

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	UpdateViewRequest.Builder

Method Summary

Modifier and Type	Method and Description
static UpdateViewRequest.Builder	builder()
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
SearchFilter	filters() An array of strings that specify which resources are included in the results of queries made using this view.
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
int	hashCode()
boolean	hasIncludedProperties() For responses, this returns true if the service returned a value for the IncludedProperties property.
List<IncludedProperty>	includedProperties() Specifies optional fields that you want included in search results from this view.
List<SdkField<?>>	sdkFields()
static Class<? extends UpdateViewRequest.Builder>	serializableBuilderClass()
UpdateViewRequest.Builder	toBuilder()
String	toString() Returns a string representation of this object.
String	viewArn() The Amazon resource name (ARN) of the view that you want to modify.

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

filters

public final SearchFilter 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.

Returns:

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.

hasIncludedProperties

public final boolean hasIncludedProperties()

For responses, this returns true if the service returned a value for the IncludedProperties property. This DOES NOT check that the value is non-empty (for which, you should check the isEmpty() method on the property). This is useful because the SDK will never return a null collection or map, but you may need to differentiate between the service returning nothing (or null) and the service returning an empty collection or map. For requests, this returns true if a value for the property was specified in the request builder, and false if a value was not specified.

includedProperties

public final List<IncludedProperty> 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.

Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.

This method will never return null. If you would like to know whether the service returned this field (so that you can differentiate between null and empty), you can use the hasIncludedProperties() method.

Returns:

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.

viewArn

public final String viewArn()

The Amazon resource name (ARN) of the view that you want to modify.

Returns:

The Amazon resource name (ARN) of the view that you want to modify.

toBuilder

public UpdateViewRequest.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<UpdateViewRequest.Builder,UpdateViewRequest>

Specified by:

toBuilder in class ResourceExplorer2Request

builder

public static UpdateViewRequest.Builder builder()

serializableBuilderClass

public static Class<? extends UpdateViewRequest.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