Package com.google.genai.gaos.models.operations

Class ListVoicesRequest

java.lang.Object
com.google.genai.gaos.models.operations.ListVoicesRequest
public class ListVoicesRequest extends Object

  • Constructor Details

  • Method Details

    • apiVersion

      public Optional<String> apiVersion()
      API version for request routing.

    • accent

      public Optional<List<String>> accent()
      Optional. Filter by accent description (e.g. "American", "British"). Case-insensitive exact match. If multiple values are specified, matches voices with any of the specified accents (OR).

    • contexts

      public Optional<List<String>> contexts()
      Optional. Filter by intended context or domain (e.g. "News, Commercial"). Case-insensitive exact match. If multiple values are specified, matches voices with any of the specified contexts (OR).

    • gender

      public Optional<List<String>> gender()
      Optional. Filter by gender presentation (e.g. "female", "male", "neutral"). Case-insensitive exact match. If multiple values are specified, matches voices with any of the specified genders (OR).

    • languageCode

      public Optional<List<String>> languageCode()
      Optional. Filter by BCP-47 language code (e.g. "en-US"). Case-insensitive exact match. If multiple values are specified, matches voices with any of the specified language codes (OR).

    • pageSize

      public Optional<Integer> pageSize()
      Optional. The maximum number of voices to return per page. The service may return fewer than this value. If unspecified, at most 50 voices are returned. The maximum value is 1000; values above 1000 are coerced to 1000.

    • pageToken

      public Optional<String> pageToken()
      Optional. A page token received from a previous `ListVoices` call. Provide this to retrieve the subsequent page.

      When paginating, all filter query parameters (`language_code`, `region_code`, `accent`, `persona`, `context`, `gender`, `pitch`, `type`, and `search`) must match the call that returned this token; otherwise the request fails with `INVALID_ARGUMENT`. `page_size` may change between pages.

    • persona

      public Optional<List<String>> persona()
      Optional. Filter by vocal persona (e.g. "Warm, Friendly"). Case-insensitive exact match. If multiple values are specified, matches voices with any of the specified personas (OR).

    • pitch

      public Optional<List<String>> pitch()
      Optional. Filter by vocal pitch. Accepts `"low"`, `"medium"`, `"high"` (case-insensitive). If multiple values are specified, matches voices with any of the specified pitches (OR).

    • regionCode

      public Optional<List<String>> regionCode()
      Optional. Filter by ISO 3166-1 alpha-2 or UN M.49 region code (e.g. "US", "001"). Case-insensitive exact match. If multiple values are specified, matches voices with any of the specified region codes (OR).

    • search

      public Optional<String> search()
      Optional. Free-text substring search query matched case-insensitively against both `display_name` and `description`. Maximum 2048 bytes.

    • type

      public Optional<List<String>> type()
      Optional. Filter by voice type. Accepts `"prebuilt"`, `"replicated"`, `"prompted"` (case-insensitive). If multiple values are specified, matches voices with any of the specified types (OR).

    • builder

      public static ListVoicesRequest.Builder builder()

    • withApiVersion

      public ListVoicesRequest withApiVersion(@Nullable String apiVersion)
      API version for request routing.

    • withAccent

      public ListVoicesRequest withAccent(@Nullable List<String> accent)
      Optional. Filter by accent description (e.g. "American", "British"). Case-insensitive exact match. If multiple values are specified, matches voices with any of the specified accents (OR).

    • withContexts

      public ListVoicesRequest withContexts(@Nullable List<String> contexts)
      Optional. Filter by intended context or domain (e.g. "News, Commercial"). Case-insensitive exact match. If multiple values are specified, matches voices with any of the specified contexts (OR).

    • withGender

      public ListVoicesRequest withGender(@Nullable List<String> gender)
      Optional. Filter by gender presentation (e.g. "female", "male", "neutral"). Case-insensitive exact match. If multiple values are specified, matches voices with any of the specified genders (OR).

    • withLanguageCode

      public ListVoicesRequest withLanguageCode(@Nullable List<String> languageCode)
      Optional. Filter by BCP-47 language code (e.g. "en-US"). Case-insensitive exact match. If multiple values are specified, matches voices with any of the specified language codes (OR).

    • withPageSize

      public ListVoicesRequest withPageSize(@Nullable Integer pageSize)
      Optional. The maximum number of voices to return per page. The service may return fewer than this value. If unspecified, at most 50 voices are returned. The maximum value is 1000; values above 1000 are coerced to 1000.

    • withPageToken

      public ListVoicesRequest withPageToken(@Nullable String pageToken)
      Optional. A page token received from a previous `ListVoices` call. Provide this to retrieve the subsequent page.

      When paginating, all filter query parameters (`language_code`, `region_code`, `accent`, `persona`, `context`, `gender`, `pitch`, `type`, and `search`) must match the call that returned this token; otherwise the request fails with `INVALID_ARGUMENT`. `page_size` may change between pages.

    • withPersona

      public ListVoicesRequest withPersona(@Nullable List<String> persona)
      Optional. Filter by vocal persona (e.g. "Warm, Friendly"). Case-insensitive exact match. If multiple values are specified, matches voices with any of the specified personas (OR).

    • withPitch

      public ListVoicesRequest withPitch(@Nullable List<String> pitch)
      Optional. Filter by vocal pitch. Accepts `"low"`, `"medium"`, `"high"` (case-insensitive). If multiple values are specified, matches voices with any of the specified pitches (OR).

    • withRegionCode

      public ListVoicesRequest withRegionCode(@Nullable List<String> regionCode)
      Optional. Filter by ISO 3166-1 alpha-2 or UN M.49 region code (e.g. "US", "001"). Case-insensitive exact match. If multiple values are specified, matches voices with any of the specified region codes (OR).

    • withSearch

      public ListVoicesRequest withSearch(@Nullable String search)
      Optional. Free-text substring search query matched case-insensitively against both `display_name` and `description`. Maximum 2048 bytes.

    • withType

      public ListVoicesRequest withType(@Nullable List<String> type)
      Optional. Filter by voice type. Accepts `"prebuilt"`, `"replicated"`, `"prompted"` (case-insensitive). If multiple values are specified, matches voices with any of the specified types (OR).

    • equals

      public boolean equals(Object o)
      Overrides:
      equals in class Object

    • hashCode

      public int hashCode()
      Overrides:
      hashCode in class Object

    • toString

      public String toString()
      Overrides:
      toString in class Object