Package software.amazon.awssdk.services.ssm.model

Interface ListDocumentsRequest.Builder

All Superinterfaces:
AwsRequest.Builder, Buildable, CopyableBuilder<ListDocumentsRequest.Builder,ListDocumentsRequest>, SdkBuilder<ListDocumentsRequest.Builder,ListDocumentsRequest>, SdkPojo, SdkRequest.Builder, SsmRequest.Builder
Enclosing class:
ListDocumentsRequest
public static interface ListDocumentsRequest.Builder extends SsmRequest.Builder, SdkPojo, CopyableBuilder<ListDocumentsRequest.Builder,ListDocumentsRequest>

  • Method Details

    • documentFilterList

      ListDocumentsRequest.Builder documentFilterList(Collection<DocumentFilter> documentFilterList)

      This data type is deprecated. Instead, use Filters.

      Parameters:
      documentFilterList - This data type is deprecated. Instead, use Filters.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • documentFilterList

      ListDocumentsRequest.Builder documentFilterList(DocumentFilter... documentFilterList)

      This data type is deprecated. Instead, use Filters.

      Parameters:
      documentFilterList - This data type is deprecated. Instead, use Filters.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • documentFilterList

      ListDocumentsRequest.Builder documentFilterList(Consumer<DocumentFilter.Builder>... documentFilterList)

      This data type is deprecated. Instead, use Filters.

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

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

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

    • filters

      ListDocumentsRequest.Builder filters(Collection<DocumentKeyValuesFilter> filters)

      One or more DocumentKeyValuesFilter objects. Use a filter to return a more specific list of results. For keys, you can specify one or more key-value pair tags that have been applied to a document. Other valid keys include Owner, Name, PlatformTypes, DocumentType, and TargetType. For example, to return documents you own use Key=Owner,Values=Self. To specify a custom key-value pair, use the format Key=tag:tagName,Values=valueName.

      This API operation only supports filtering documents by using a single tag key and one or more tag values. For example: Key=tag:tagName,Values=valueName1,valueName2

      Parameters:
      filters - One or more DocumentKeyValuesFilter objects. Use a filter to return a more specific list of results. For keys, you can specify one or more key-value pair tags that have been applied to a document. Other valid keys include Owner, Name, PlatformTypes, DocumentType, and TargetType. For example, to return documents you own use Key=Owner,Values=Self. To specify a custom key-value pair, use the format Key=tag:tagName,Values=valueName.

      This API operation only supports filtering documents by using a single tag key and one or more tag values. For example: Key=tag:tagName,Values=valueName1,valueName2

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

    • filters

      ListDocumentsRequest.Builder filters(DocumentKeyValuesFilter... filters)

      One or more DocumentKeyValuesFilter objects. Use a filter to return a more specific list of results. For keys, you can specify one or more key-value pair tags that have been applied to a document. Other valid keys include Owner, Name, PlatformTypes, DocumentType, and TargetType. For example, to return documents you own use Key=Owner,Values=Self. To specify a custom key-value pair, use the format Key=tag:tagName,Values=valueName.

      This API operation only supports filtering documents by using a single tag key and one or more tag values. For example: Key=tag:tagName,Values=valueName1,valueName2

      Parameters:
      filters - One or more DocumentKeyValuesFilter objects. Use a filter to return a more specific list of results. For keys, you can specify one or more key-value pair tags that have been applied to a document. Other valid keys include Owner, Name, PlatformTypes, DocumentType, and TargetType. For example, to return documents you own use Key=Owner,Values=Self. To specify a custom key-value pair, use the format Key=tag:tagName,Values=valueName.

      This API operation only supports filtering documents by using a single tag key and one or more tag values. For example: Key=tag:tagName,Values=valueName1,valueName2

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

    • filters

      ListDocumentsRequest.Builder filters(Consumer<DocumentKeyValuesFilter.Builder>... filters)

      One or more DocumentKeyValuesFilter objects. Use a filter to return a more specific list of results. For keys, you can specify one or more key-value pair tags that have been applied to a document. Other valid keys include Owner, Name, PlatformTypes, DocumentType, and TargetType. For example, to return documents you own use Key=Owner,Values=Self. To specify a custom key-value pair, use the format Key=tag:tagName,Values=valueName.

      This API operation only supports filtering documents by using a single tag key and one or more tag values. For example: Key=tag:tagName,Values=valueName1,valueName2

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

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

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

    • maxResults

      ListDocumentsRequest.Builder maxResults(Integer maxResults)

      The maximum number of items to return for this call. The call also returns a token that you can specify in a subsequent call to get the next set of results.

      Parameters:
      maxResults - The maximum number of items to return for this call. The call also returns a token that you can specify in a subsequent call to get the next set of results.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • nextToken

      ListDocumentsRequest.Builder nextToken(String nextToken)

      The token for the next set of items to return. (You received this token from a previous call.)

      Parameters:
      nextToken - The token for the next set of items to return. (You received this token from a previous call.)
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • overrideConfiguration

      ListDocumentsRequest.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

      ListDocumentsRequest.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.