Interface ListCampaignsRequest.Builder
- All Superinterfaces:
AwsRequest.Builder,Buildable,CopyableBuilder<ListCampaignsRequest.Builder,,ListCampaignsRequest> PartnerCentralMarketingRequest.Builder,SdkBuilder<ListCampaignsRequest.Builder,,ListCampaignsRequest> SdkPojo,SdkRequest.Builder
- Enclosing class:
ListCampaignsRequest
-
Method Summary
Modifier and TypeMethodDescriptioncampaignIdentifiers(String... campaignIdentifiers) Only these campaigns, each named by its id or its campaign ARN.campaignIdentifiers(Collection<String> campaignIdentifiers) Only these campaigns, each named by its id or its campaign ARN.The catalog (AWS or Sandbox).The catalog (AWS or Sandbox).maxResults(Integer maxResults) Maximum results per page.Only campaigns whose name contains this, compared case-insensitively.Pagination token.overrideConfiguration(Consumer<AwsRequestOverrideConfiguration.Builder> builderConsumer) Add an optional request override configuration.overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration) Add an optional request override configuration.default ListCampaignsRequest.Buildersort(Consumer<CampaignSort.Builder> sort) The order of the results.sort(CampaignSort sort) The order of the results.states(Collection<CampaignState> states) Only campaigns in one of these states.states(CampaignState... states) Only campaigns in one of these states.statesWithStrings(String... states) Only campaigns in one of these states.statesWithStrings(Collection<String> states) Only campaigns in one of these states.Methods inherited from interface software.amazon.awssdk.awscore.AwsRequest.Builder
overrideConfigurationMethods inherited from interface software.amazon.awssdk.utils.builder.CopyableBuilder
copyMethods inherited from interface software.amazon.awssdk.services.partnercentralmarketing.model.PartnerCentralMarketingRequest.Builder
buildMethods inherited from interface software.amazon.awssdk.utils.builder.SdkBuilder
applyMutation, buildMethods inherited from interface software.amazon.awssdk.core.SdkPojo
equalsBySdkFields, sdkFieldNameToField, sdkFields
-
Method Details
-
catalog
The catalog (AWS or Sandbox).
- Parameters:
catalog- The catalog (AWS or Sandbox).- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
-
catalog
The catalog (AWS or Sandbox).
- Parameters:
catalog- The catalog (AWS or Sandbox).- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
-
campaignIdentifiers
Only these campaigns, each named by its id or its campaign ARN. A campaign that does not exist, was deleted, or whose ARN names another account or catalog is left out rather than refused.
- Parameters:
campaignIdentifiers- Only these campaigns, each named by its id or its campaign ARN. A campaign that does not exist, was deleted, or whose ARN names another account or catalog is left out rather than refused.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
campaignIdentifiers
Only these campaigns, each named by its id or its campaign ARN. A campaign that does not exist, was deleted, or whose ARN names another account or catalog is left out rather than refused.
- Parameters:
campaignIdentifiers- Only these campaigns, each named by its id or its campaign ARN. A campaign that does not exist, was deleted, or whose ARN names another account or catalog is left out rather than refused.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
name
Only campaigns whose name contains this, compared case-insensitively.
- Parameters:
name- Only campaigns whose name contains this, compared case-insensitively.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
statesWithStrings
Only campaigns in one of these states.
- Parameters:
states- Only campaigns in one of these states.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
statesWithStrings
Only campaigns in one of these states.
- Parameters:
states- Only campaigns in one of these states.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
states
Only campaigns in one of these states.
- Parameters:
states- Only campaigns in one of these states.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
states
Only campaigns in one of these states.
- Parameters:
states- Only campaigns in one of these states.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
sort
The order of the results. Default:
CREATED_AT,DESCENDING.- Parameters:
sort- The order of the results. Default:CREATED_AT,DESCENDING.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
sort
The order of the results. Default:
This is a convenience method that creates an instance of theCREATED_AT,DESCENDING.CampaignSort.Builderavoiding the need to create one manually viaCampaignSort.builder().When the
Consumercompletes,SdkBuilder.build()is called immediately and its result is passed tosort(CampaignSort).- Parameters:
sort- a consumer that will call methods onCampaignSort.Builder- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
-
maxResults
Maximum results per page.
- Parameters:
maxResults- Maximum results per page.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
nextToken
Pagination token. Bound to the filters and sort it was issued for: a request that changes
CampaignIdentifiers,Name,StatesorSortbetween pages is refused withValidationException.MaxResultsmay change.- Parameters:
nextToken- Pagination token. Bound to the filters and sort it was issued for: a request that changesCampaignIdentifiers,Name,StatesorSortbetween pages is refused withValidationException.MaxResultsmay change.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
overrideConfiguration
ListCampaignsRequest.Builder overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration) Description copied from interface:AwsRequest.BuilderAdd an optional request override configuration.- Specified by:
overrideConfigurationin interfaceAwsRequest.Builder- Parameters:
overrideConfiguration- The override configuration.- Returns:
- This object for method chaining.
-
overrideConfiguration
ListCampaignsRequest.Builder overrideConfiguration(Consumer<AwsRequestOverrideConfiguration.Builder> builderConsumer) Description copied from interface:AwsRequest.BuilderAdd an optional request override configuration.- Specified by:
overrideConfigurationin interfaceAwsRequest.Builder- Parameters:
builderConsumer- AConsumerto which an emptyAwsRequestOverrideConfiguration.Builderwill be given.- Returns:
- This object for method chaining.
-