@Generated(value="software.amazon.awssdk:codegen") public final class CreateViewRequest extends ResourceExplorer2Request implements ToCopyableBuilder<CreateViewRequest.Builder,CreateViewRequest>
| Modifier and Type | Class and Description |
|---|---|
static interface |
CreateViewRequest.Builder |
| Modifier and Type | Method and Description |
|---|---|
static CreateViewRequest.Builder |
builder() |
String |
clientToken()
This value helps ensure idempotency.
|
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.
|
boolean |
hasTags()
For responses, this returns true if the service returned a value for the Tags property.
|
List<IncludedProperty> |
includedProperties()
Specifies optional fields that you want included in search results from this view.
|
List<SdkField<?>> |
sdkFields() |
static Class<? extends CreateViewRequest.Builder> |
serializableBuilderClass() |
Map<String,String> |
tags()
Tag key and value pairs that are attached to the view.
|
CreateViewRequest.Builder |
toBuilder() |
String |
toString()
Returns a string representation of this object.
|
String |
viewName()
The name of the new view.
|
overrideConfigurationclone, finalize, getClass, notify, notifyAll, wait, wait, waitcopypublic final String clientToken()
This value helps ensure idempotency. Resource Explorer uses this value to prevent the accidental creation of duplicate versions. We recommend that you generate a UUID-type value to ensure the uniqueness of your views.
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.
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 final boolean hasIncludedProperties()
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.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.
The default is an empty list, with no optional fields included in the results.
public final boolean hasTags()
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.public final Map<String,String> tags()
Tag key and value pairs that are attached to the view.
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 hasTags() method.
public final String viewName()
The name of the new view. This name appears in the list of views in Resource Explorer.
The name must be no more than 64 characters long, and can include letters, digits, and the dash (-) character. The name must be unique within its Amazon Web Services Region.
The name must be no more than 64 characters long, and can include letters, digits, and the dash (-) character. The name must be unique within its Amazon Web Services Region.
public CreateViewRequest.Builder toBuilder()
toBuilder in interface ToCopyableBuilder<CreateViewRequest.Builder,CreateViewRequest>toBuilder in class ResourceExplorer2Requestpublic static CreateViewRequest.Builder builder()
public static Class<? extends CreateViewRequest.Builder> serializableBuilderClass()
public final int hashCode()
hashCode in class AwsRequestpublic final boolean equals(Object obj)
equals in class AwsRequestpublic final boolean equalsBySdkFields(Object obj)
equalsBySdkFields in interface SdkPojopublic final String toString()
public final <T> Optional<T> getValueForField(String fieldName, Class<T> clazz)
getValueForField in class SdkRequestCopyright © 2023. All rights reserved.