Interface SearchCampaignTemplatesRequest.Builder

  • Method Details

    • catalog

      The catalog (AWS or Sandbox). AWS and Sandbox templates may differ.

      Parameters:
      catalog - The catalog (AWS or Sandbox). AWS and Sandbox templates may differ.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:
    • catalog

      The catalog (AWS or Sandbox). AWS and Sandbox templates may differ.

      Parameters:
      catalog - The catalog (AWS or Sandbox). AWS and Sandbox templates may differ.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:
    • searchText

      Free-text query matched against the template's name and description. Any word may match, and the last word matches as a prefix when it has 3 or more characters, so nov finds Amazon Nova. A template whose name holds the query as a phrase ranks first, then whole-word matches, then prefix-only ones. Omit to browse the whole catalog. Text analysis is derived from each template's own LanguageCode, never from the language filter.

      Parameters:
      searchText - Free-text query matched against the template's name and description. Any word may match, and the last word matches as a prefix when it has 3 or more characters, so nov finds Amazon Nova. A template whose name holds the query as a phrase ranks first, then whole-word matches, then prefix-only ones. Omit to browse the whole catalog. Text analysis is derived from each template's own LanguageCode, never from the language filter.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
    • industryWithStrings

      Restrict to templates in these industries. Values within this member are OR-ed; distinct facet members are AND-ed. Exact, case-sensitive match.

      Parameters:
      industry - Restrict to templates in these industries. Values within this member are OR-ed; distinct facet members are AND-ed. Exact, case-sensitive match.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
    • industryWithStrings

      SearchCampaignTemplatesRequest.Builder industryWithStrings(String... industry)

      Restrict to templates in these industries. Values within this member are OR-ed; distinct facet members are AND-ed. Exact, case-sensitive match.

      Parameters:
      industry - Restrict to templates in these industries. Values within this member are OR-ed; distinct facet members are AND-ed. Exact, case-sensitive match.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
    • industry

      Restrict to templates in these industries. Values within this member are OR-ed; distinct facet members are AND-ed. Exact, case-sensitive match.

      Parameters:
      industry - Restrict to templates in these industries. Values within this member are OR-ed; distinct facet members are AND-ed. Exact, case-sensitive match.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
    • industry

      Restrict to templates in these industries. Values within this member are OR-ed; distinct facet members are AND-ed. Exact, case-sensitive match.

      Parameters:
      industry - Restrict to templates in these industries. Values within this member are OR-ed; distinct facet members are AND-ed. Exact, case-sensitive match.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
    • useCase

      Restrict to templates with these campaign use cases. Values within this member are OR-ed; distinct facet members are AND-ed. Exact, case-sensitive match.

      Parameters:
      useCase - Restrict to templates with these campaign use cases. Values within this member are OR-ed; distinct facet members are AND-ed. Exact, case-sensitive match.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
    • useCase

      Restrict to templates with these campaign use cases. Values within this member are OR-ed; distinct facet members are AND-ed. Exact, case-sensitive match.

      Parameters:
      useCase - Restrict to templates with these campaign use cases. Values within this member are OR-ed; distinct facet members are AND-ed. Exact, case-sensitive match.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
    • languageWithStrings

      Restrict to templates in these language(s), matched by each template's LanguageCode. Values within this member are OR-ed; distinct facet members are AND-ed. Narrows results; it does not reinterpret SearchText.

      Parameters:
      language - Restrict to templates in these language(s), matched by each template's LanguageCode. Values within this member are OR-ed; distinct facet members are AND-ed. Narrows results; it does not reinterpret SearchText.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
    • languageWithStrings

      SearchCampaignTemplatesRequest.Builder languageWithStrings(String... language)

      Restrict to templates in these language(s), matched by each template's LanguageCode. Values within this member are OR-ed; distinct facet members are AND-ed. Narrows results; it does not reinterpret SearchText.

      Parameters:
      language - Restrict to templates in these language(s), matched by each template's LanguageCode. Values within this member are OR-ed; distinct facet members are AND-ed. Narrows results; it does not reinterpret SearchText.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
    • language

      Restrict to templates in these language(s), matched by each template's LanguageCode. Values within this member are OR-ed; distinct facet members are AND-ed. Narrows results; it does not reinterpret SearchText.

      Parameters:
      language - Restrict to templates in these language(s), matched by each template's LanguageCode. Values within this member are OR-ed; distinct facet members are AND-ed. Narrows results; it does not reinterpret SearchText.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
    • language

      Restrict to templates in these language(s), matched by each template's LanguageCode. Values within this member are OR-ed; distinct facet members are AND-ed. Narrows results; it does not reinterpret SearchText.

      Parameters:
      language - Restrict to templates in these language(s), matched by each template's LanguageCode. Values within this member are OR-ed; distinct facet members are AND-ed. Narrows results; it does not reinterpret SearchText.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
    • awsServices

      Restrict to templates promoting these AWS services. Values within this member are OR-ed; distinct facet members are AND-ed. Exact, case-sensitive match.

      Parameters:
      awsServices - Restrict to templates promoting these AWS services. Values within this member are OR-ed; distinct facet members are AND-ed. Exact, case-sensitive match.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
    • awsServices

      SearchCampaignTemplatesRequest.Builder awsServices(String... awsServices)

      Restrict to templates promoting these AWS services. Values within this member are OR-ed; distinct facet members are AND-ed. Exact, case-sensitive match.

      Parameters:
      awsServices - Restrict to templates promoting these AWS services. Values within this member are OR-ed; distinct facet members are AND-ed. Exact, case-sensitive match.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
    • customerSegmentsWithStrings

      SearchCampaignTemplatesRequest.Builder customerSegmentsWithStrings(Collection<String> customerSegments)

      Restrict to templates for these customer segments. Values within this member are OR-ed; distinct facet members are AND-ed. A template that names no customer segment matches every value.

      Parameters:
      customerSegments - Restrict to templates for these customer segments. Values within this member are OR-ed; distinct facet members are AND-ed. A template that names no customer segment matches every value.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
    • customerSegmentsWithStrings

      SearchCampaignTemplatesRequest.Builder customerSegmentsWithStrings(String... customerSegments)

      Restrict to templates for these customer segments. Values within this member are OR-ed; distinct facet members are AND-ed. A template that names no customer segment matches every value.

      Parameters:
      customerSegments - Restrict to templates for these customer segments. Values within this member are OR-ed; distinct facet members are AND-ed. A template that names no customer segment matches every value.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
    • customerSegments

      Restrict to templates for these customer segments. Values within this member are OR-ed; distinct facet members are AND-ed. A template that names no customer segment matches every value.

      Parameters:
      customerSegments - Restrict to templates for these customer segments. Values within this member are OR-ed; distinct facet members are AND-ed. A template that names no customer segment matches every value.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
    • customerSegments

      SearchCampaignTemplatesRequest.Builder customerSegments(CustomerSegment... customerSegments)

      Restrict to templates for these customer segments. Values within this member are OR-ed; distinct facet members are AND-ed. A template that names no customer segment matches every value.

      Parameters:
      customerSegments - Restrict to templates for these customer segments. Values within this member are OR-ed; distinct facet members are AND-ed. A template that names no customer segment matches every value.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
    • themesWithStrings

      Restrict to templates with these themes. Values within this member are OR-ed; distinct facet members are AND-ed. A template that names no theme matches every value.

      Parameters:
      themes - Restrict to templates with these themes. Values within this member are OR-ed; distinct facet members are AND-ed. A template that names no theme matches every value.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
    • themesWithStrings

      SearchCampaignTemplatesRequest.Builder themesWithStrings(String... themes)

      Restrict to templates with these themes. Values within this member are OR-ed; distinct facet members are AND-ed. A template that names no theme matches every value.

      Parameters:
      themes - Restrict to templates with these themes. Values within this member are OR-ed; distinct facet members are AND-ed. A template that names no theme matches every value.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
    • themes

      Restrict to templates with these themes. Values within this member are OR-ed; distinct facet members are AND-ed. A template that names no theme matches every value.

      Parameters:
      themes - Restrict to templates with these themes. Values within this member are OR-ed; distinct facet members are AND-ed. A template that names no theme matches every value.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
    • themes

      Restrict to templates with these themes. Values within this member are OR-ed; distinct facet members are AND-ed. A template that names no theme matches every value.

      Parameters:
      themes - Restrict to templates with these themes. Values within this member are OR-ed; distinct facet members are AND-ed. A template that names no theme matches every value.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
    • collectionWithStrings

      SearchCampaignTemplatesRequest.Builder collectionWithStrings(Collection<String> collection)

      Restrict to templates in these collections. Values within this member are OR-ed; distinct facet members are AND-ed. Omit for no restriction; there is no default.

      Parameters:
      collection - Restrict to templates in these collections. Values within this member are OR-ed; distinct facet members are AND-ed. Omit for no restriction; there is no default.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
    • collectionWithStrings

      SearchCampaignTemplatesRequest.Builder collectionWithStrings(String... collection)

      Restrict to templates in these collections. Values within this member are OR-ed; distinct facet members are AND-ed. Omit for no restriction; there is no default.

      Parameters:
      collection - Restrict to templates in these collections. Values within this member are OR-ed; distinct facet members are AND-ed. Omit for no restriction; there is no default.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
    • collection

      Restrict to templates in these collections. Values within this member are OR-ed; distinct facet members are AND-ed. Omit for no restriction; there is no default.

      Parameters:
      collection - Restrict to templates in these collections. Values within this member are OR-ed; distinct facet members are AND-ed. Omit for no restriction; there is no default.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
    • collection

      Restrict to templates in these collections. Values within this member are OR-ed; distinct facet members are AND-ed. Omit for no restriction; there is no default.

      Parameters:
      collection - Restrict to templates in these collections. Values within this member are OR-ed; distinct facet members are AND-ed. Omit for no restriction; there is no default.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
    • 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.

      Parameters:
      nextToken - Pagination token.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
    • overrideConfiguration

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

      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.