Interface DescribeOpsItemsRequest.Builder

All Superinterfaces:

AwsRequest.Builder, Buildable, CopyableBuilder<DescribeOpsItemsRequest.Builder,DescribeOpsItemsRequest>, SdkBuilder<DescribeOpsItemsRequest.Builder,DescribeOpsItemsRequest>, SdkPojo, SdkRequest.Builder, SsmRequest.Builder

Enclosing class:

DescribeOpsItemsRequest

@Mutable
@NotThreadSafe
public static interface DescribeOpsItemsRequest.Builder
extends SsmRequest.Builder, SdkPojo, CopyableBuilder<DescribeOpsItemsRequest.Builder,DescribeOpsItemsRequest>

Method Summary

Modifier and Type	Method	Description
DescribeOpsItemsRequest.Builder	maxResults(Integer maxResults)	The maximum number of items to return for this call.
DescribeOpsItemsRequest.Builder	nextToken(String nextToken)	A token to start the list.
DescribeOpsItemsRequest.Builder	opsItemFilters(Collection<OpsItemFilter> opsItemFilters)	One or more filters to limit the response.
DescribeOpsItemsRequest.Builder	opsItemFilters(Consumer<OpsItemFilter.Builder>... opsItemFilters)	One or more filters to limit the response.
DescribeOpsItemsRequest.Builder	opsItemFilters(OpsItemFilter... opsItemFilters)	One or more filters to limit the response.
DescribeOpsItemsRequest.Builder	overrideConfiguration(Consumer<AwsRequestOverrideConfiguration.Builder> builderConsumer)	Add an optional request override configuration.
DescribeOpsItemsRequest.Builder	overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration)	Add an optional request override configuration.

Methods inherited from interface software.amazon.awssdk.awscore.AwsRequest.Builder

overrideConfiguration

Methods inherited from interface software.amazon.awssdk.utils.builder.CopyableBuilder

copy

Methods inherited from interface software.amazon.awssdk.utils.builder.SdkBuilder

applyMutation, build

Methods inherited from interface software.amazon.awssdk.core.SdkPojo

equalsBySdkFields, sdkFieldNameToField, sdkFields

Methods inherited from interface software.amazon.awssdk.services.ssm.model.SsmRequest.Builder

build

Method Details

opsItemFilters

DescribeOpsItemsRequest.Builder opsItemFilters(Collection<OpsItemFilter> opsItemFilters)

One or more filters to limit the response.

• Key: CreatedTime

  Operations: GreaterThan, LessThan

• Key: LastModifiedBy

  Operations: Contains, Equals

• Key: LastModifiedTime

  Operations: GreaterThan, LessThan

• Key: Priority

  Operations: Equals

• Key: Source

  Operations: Contains, Equals

• Key: Status

  Operations: Equals

• Key: Title*

  Operations: Equals,Contains

• Key: OperationalData**

  Operations: Equals

• Key: OperationalDataKey

  Operations: Equals

• Key: OperationalDataValue

  Operations: Equals, Contains

• Key: OpsItemId

  Operations: Equals

• Key: ResourceId

  Operations: Contains

• Key: AutomationId

  Operations: Equals

• Key: AccountId

  Operations: Equals

*The Equals operator for Title matches the first 100 characters. If you specify more than 100 characters, they system returns an error that the filter value exceeds the length limit.

**If you filter the response by using the OperationalData operator, specify a key-value pair by using the following JSON format: {"key":"key_name","value":"a_value"}

Parameters:

opsItemFilters - One or more filters to limit the response.

• Key: CreatedTime

  Operations: GreaterThan, LessThan

• Key: LastModifiedBy

  Operations: Contains, Equals

• Key: LastModifiedTime

  Operations: GreaterThan, LessThan

• Key: Priority

  Operations: Equals

• Key: Source

  Operations: Contains, Equals

• Key: Status

  Operations: Equals

• Key: Title*

  Operations: Equals,Contains

• Key: OperationalData**

  Operations: Equals

• Key: OperationalDataKey

  Operations: Equals

• Key: OperationalDataValue

  Operations: Equals, Contains

• Key: OpsItemId

  Operations: Equals

• Key: ResourceId

  Operations: Contains

• Key: AutomationId

  Operations: Equals

• Key: AccountId

  Operations: Equals

*The Equals operator for Title matches the first 100 characters. If you specify more than 100 characters, they system returns an error that the filter value exceeds the length limit.

**If you filter the response by using the OperationalData operator, specify a key-value pair by using the following JSON format: {"key":"key_name","value":"a_value"}

Returns:

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

opsItemFilters

DescribeOpsItemsRequest.Builder opsItemFilters(OpsItemFilter... opsItemFilters)

One or more filters to limit the response.

• Key: CreatedTime

  Operations: GreaterThan, LessThan

• Key: LastModifiedBy

  Operations: Contains, Equals

• Key: LastModifiedTime

  Operations: GreaterThan, LessThan

• Key: Priority

  Operations: Equals

• Key: Source

  Operations: Contains, Equals

• Key: Status

  Operations: Equals

• Key: Title*

  Operations: Equals,Contains

• Key: OperationalData**

  Operations: Equals

• Key: OperationalDataKey

  Operations: Equals

• Key: OperationalDataValue

  Operations: Equals, Contains

• Key: OpsItemId

  Operations: Equals

• Key: ResourceId

  Operations: Contains

• Key: AutomationId

  Operations: Equals

• Key: AccountId

  Operations: Equals

*The Equals operator for Title matches the first 100 characters. If you specify more than 100 characters, they system returns an error that the filter value exceeds the length limit.

**If you filter the response by using the OperationalData operator, specify a key-value pair by using the following JSON format: {"key":"key_name","value":"a_value"}

Parameters:

opsItemFilters - One or more filters to limit the response.

• Key: CreatedTime

  Operations: GreaterThan, LessThan

• Key: LastModifiedBy

  Operations: Contains, Equals

• Key: LastModifiedTime

  Operations: GreaterThan, LessThan

• Key: Priority

  Operations: Equals

• Key: Source

  Operations: Contains, Equals

• Key: Status

  Operations: Equals

• Key: Title*

  Operations: Equals,Contains

• Key: OperationalData**

  Operations: Equals

• Key: OperationalDataKey

  Operations: Equals

• Key: OperationalDataValue

  Operations: Equals, Contains

• Key: OpsItemId

  Operations: Equals

• Key: ResourceId

  Operations: Contains

• Key: AutomationId

  Operations: Equals

• Key: AccountId

  Operations: Equals

*The Equals operator for Title matches the first 100 characters. If you specify more than 100 characters, they system returns an error that the filter value exceeds the length limit.

**If you filter the response by using the OperationalData operator, specify a key-value pair by using the following JSON format: {"key":"key_name","value":"a_value"}

Returns:

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

opsItemFilters

DescribeOpsItemsRequest.Builder opsItemFilters(Consumer<OpsItemFilter.Builder>... opsItemFilters)

One or more filters to limit the response.

• Key: CreatedTime

  Operations: GreaterThan, LessThan

• Key: LastModifiedBy

  Operations: Contains, Equals

• Key: LastModifiedTime

  Operations: GreaterThan, LessThan

• Key: Priority

  Operations: Equals

• Key: Source

  Operations: Contains, Equals

• Key: Status

  Operations: Equals

• Key: Title*

  Operations: Equals,Contains

• Key: OperationalData**

  Operations: Equals

• Key: OperationalDataKey

  Operations: Equals

• Key: OperationalDataValue

  Operations: Equals, Contains

• Key: OpsItemId

  Operations: Equals

• Key: ResourceId

  Operations: Contains

• Key: AutomationId

  Operations: Equals

• Key: AccountId

  Operations: Equals

*The Equals operator for Title matches the first 100 characters. If you specify more than 100 characters, they system returns an error that the filter value exceeds the length limit.

**If you filter the response by using the OperationalData operator, specify a key-value pair by using the following JSON format: {"key":"key_name","value":"a_value"}

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

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

Parameters:

opsItemFilters - a consumer that will call methods on OpsItemFilter.Builder

Returns:

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

See Also:

• opsItemFilters(java.util.Collection<OpsItemFilter>)

maxResults

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

DescribeOpsItemsRequest.Builder nextToken(String nextToken)

A token to start the list. Use this token to get the next set of results.

Parameters:

nextToken - A token to start the list. Use this token to get the next set of results.

Returns:

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

overrideConfiguration

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

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