Interface CreateViewRequest.Builder

All Superinterfaces:
AwsRequest.Builder, Buildable, CopyableBuilder<CreateViewRequest.Builder,CreateViewRequest>, ResourceExplorer2Request.Builder, SdkBuilder<CreateViewRequest.Builder,CreateViewRequest>, SdkPojo, SdkRequest.Builder
Enclosing class:
CreateViewRequest
@Mutable @NotThreadSafe public static interface CreateViewRequest.Builder extends ResourceExplorer2Request.Builder, SdkPojo, CopyableBuilder<CreateViewRequest.Builder,CreateViewRequest>

  • Method Details

    • clientToken

      CreateViewRequest.Builder clientToken(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.

      Parameters:
      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.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • filters

      CreateViewRequest.Builder filters(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.

      Parameters:
      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:
      Returns a reference to this object so that method calls can be chained together.

    • filters

      default CreateViewRequest.Builder filters(Consumer<SearchFilter.Builder> 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.

      This is a convenience method that creates an instance of the SearchFilter.Builder avoiding the need to create one manually via SearchFilter.builder().

      When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to filters(SearchFilter).

      Parameters:
      filters - a consumer that will call methods on SearchFilter.Builder
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • includedProperties

      CreateViewRequest.Builder includedProperties(Collection<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.

      Parameters:
      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.

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

    • includedProperties

      CreateViewRequest.Builder includedProperties(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.

      Parameters:
      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.

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

    • includedProperties

      CreateViewRequest.Builder includedProperties(Consumer<IncludedProperty.Builder>... 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.

      This is a convenience method that creates an instance of the IncludedProperty.Builder avoiding the need to create one manually via IncludedProperty.builder().

      When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to includedProperties(List<IncludedProperty>).

      Parameters:
      includedProperties - a consumer that will call methods on IncludedProperty.Builder
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • scope

      CreateViewRequest.Builder scope(String scope)

      The root ARN of the account, an organizational unit (OU), or an organization ARN. If left empty, the default is account.

      Parameters:
      scope - The root ARN of the account, an organizational unit (OU), or an organization ARN. If left empty, the default is account.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • tags

      CreateViewRequest.Builder tags(Map<String,String> tags)

      Tag key and value pairs that are attached to the view.

      Parameters:
      tags - Tag key and value pairs that are attached to the view.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • viewName

      CreateViewRequest.Builder viewName(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.

      Parameters:
      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.

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

    • overrideConfiguration

      CreateViewRequest.Builder overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration)
      Description copied from interface: AwsRequest.Builder
      Add an optional request override configuration.
      Specified by:
      overrideConfiguration in interface AwsRequest.Builder
      Parameters:
      overrideConfiguration - The override configuration.
      Returns:
      This object for method chaining.

    • overrideConfiguration

      CreateViewRequest.Builder overrideConfiguration(Consumer<AwsRequestOverrideConfiguration.Builder> builderConsumer)
      Description copied from interface: AwsRequest.Builder
      Add an optional request override configuration.
      Specified by:
      overrideConfiguration in interface AwsRequest.Builder
      Parameters:
      builderConsumer - A Consumer to which an empty AwsRequestOverrideConfiguration.Builder will be given.
      Returns:
      This object for method chaining.