Class BrowserLanguageServiceClient (0.39.0)

Service Description: Provides methods for handling BrowserLanguage objects.

This class provides the ability to make remote calls to the backing service through method calls that map to API methods. Sample code to get started:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (BrowserLanguageServiceClient browserLanguageServiceClient =
     BrowserLanguageServiceClient.create()) {
   BrowserLanguageName name = BrowserLanguageName.of("[NETWORK_CODE]", "[BROWSER_LANGUAGE]");
   BrowserLanguage response = browserLanguageServiceClient.getBrowserLanguage(name);
 }

Note: close() needs to be called on the BrowserLanguageServiceClient object to clean up resources such as threads. In the example above, try-with-resources is used, which automatically calls close().

Methods
Method	Description	Method Variants
GetBrowserLanguage	API to retrieve a `BrowserLanguage` object.	Request object method variants only take one parameter, a request object, which must be constructed before the call. getBrowserLanguage(GetBrowserLanguageRequest request) "Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method. getBrowserLanguage(BrowserLanguageName name) getBrowserLanguage(String name) Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service. getBrowserLanguageCallable()
ListBrowserLanguages	API to retrieve a list of `BrowserLanguage` objects.	Request object method variants only take one parameter, a request object, which must be constructed before the call. listBrowserLanguages(ListBrowserLanguagesRequest request) "Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method. listBrowserLanguages(NetworkName parent) listBrowserLanguages(String parent) Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service. listBrowserLanguagesPagedCallable() listBrowserLanguagesCallable()

See the individual methods for example code.

Many parameters require resource names to be formatted in a particular way. To assist with these names, this class includes a format method for each type of name, and additionally a parse method to extract the individual identifiers contained within names that are returned.

This class can be customized by passing in a custom instance of BrowserLanguageServiceSettings to create(). For example:

To customize credentials:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 BrowserLanguageServiceSettings browserLanguageServiceSettings =
     BrowserLanguageServiceSettings.newBuilder()
         .setCredentialsProvider(FixedCredentialsProvider.create(myCredentials))
         .build();
 BrowserLanguageServiceClient browserLanguageServiceClient =
     BrowserLanguageServiceClient.create(browserLanguageServiceSettings);

To customize the endpoint:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 BrowserLanguageServiceSettings browserLanguageServiceSettings =
     BrowserLanguageServiceSettings.newBuilder().setEndpoint(myEndpoint).build();
 BrowserLanguageServiceClient browserLanguageServiceClient =
     BrowserLanguageServiceClient.create(browserLanguageServiceSettings);

Please refer to the GitHub repository's samples for more quickstart code snippets.

Inheritance

java.lang.Object > BrowserLanguageServiceClient

Static Methods

create()

public static final BrowserLanguageServiceClient create()

Constructs an instance of BrowserLanguageServiceClient with default settings.

Returns
Type	Description
`BrowserLanguageServiceClient`

Exceptions
Type	Description
`IOException`

create(BrowserLanguageServiceSettings settings)

public static final BrowserLanguageServiceClient create(BrowserLanguageServiceSettings settings)

Constructs an instance of BrowserLanguageServiceClient, using the given settings. The channels are created based on the settings passed in, or defaults for any settings that are not set.

Parameter
Name	Description
`settings`	`BrowserLanguageServiceSettings`

Returns
Type	Description
`BrowserLanguageServiceClient`

Exceptions
Type	Description
`IOException`

create(BrowserLanguageServiceStub stub)

public static final BrowserLanguageServiceClient create(BrowserLanguageServiceStub stub)

Constructs an instance of BrowserLanguageServiceClient, using the given stub for making calls. This is for advanced usage - prefer using create(BrowserLanguageServiceSettings).

Parameter
Name	Description
`stub`	`BrowserLanguageServiceStub`

Returns
Type	Description
`BrowserLanguageServiceClient`

Constructors

BrowserLanguageServiceClient(BrowserLanguageServiceSettings settings)

protected BrowserLanguageServiceClient(BrowserLanguageServiceSettings settings)

Constructs an instance of BrowserLanguageServiceClient, using the given settings. This is protected so that it is easy to make a subclass, but otherwise, the static factory methods should be preferred.

Parameter
Name	Description
`settings`	`BrowserLanguageServiceSettings`

BrowserLanguageServiceClient(BrowserLanguageServiceStub stub)

protected BrowserLanguageServiceClient(BrowserLanguageServiceStub stub)

Parameter
Name	Description
`stub`	`BrowserLanguageServiceStub`

Methods

awaitTermination(long duration, TimeUnit unit)

public boolean awaitTermination(long duration, TimeUnit unit)

Parameters
Name	Description
`duration`	`long`
`unit`	`TimeUnit`

Returns
Type	Description
`boolean`

Exceptions
Type	Description
`InterruptedException`

close()

public final void close()

getBrowserLanguage(BrowserLanguageName name)

public final BrowserLanguage getBrowserLanguage(BrowserLanguageName name)

API to retrieve a BrowserLanguage object.

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (BrowserLanguageServiceClient browserLanguageServiceClient =
     BrowserLanguageServiceClient.create()) {
   BrowserLanguageName name = BrowserLanguageName.of("[NETWORK_CODE]", "[BROWSER_LANGUAGE]");
   BrowserLanguage response = browserLanguageServiceClient.getBrowserLanguage(name);
 }

Parameter
Name	Description
`name`	`BrowserLanguageName` Required. The resource name of the BrowserLanguage. Format: `networks/{network_code}/browserLanguages/{browser_language_id}`

Returns
Type	Description
`BrowserLanguage`

getBrowserLanguage(GetBrowserLanguageRequest request)

public final BrowserLanguage getBrowserLanguage(GetBrowserLanguageRequest request)

API to retrieve a BrowserLanguage object.

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (BrowserLanguageServiceClient browserLanguageServiceClient =
     BrowserLanguageServiceClient.create()) {
   GetBrowserLanguageRequest request =
       GetBrowserLanguageRequest.newBuilder()
           .setName(BrowserLanguageName.of("[NETWORK_CODE]", "[BROWSER_LANGUAGE]").toString())
           .build();
   BrowserLanguage response = browserLanguageServiceClient.getBrowserLanguage(request);
 }

Parameter
Name	Description
`request`	`GetBrowserLanguageRequest` The request object containing all of the parameters for the API call.

Returns
Type	Description
`BrowserLanguage`

getBrowserLanguage(String name)

public final BrowserLanguage getBrowserLanguage(String name)

API to retrieve a BrowserLanguage object.

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (BrowserLanguageServiceClient browserLanguageServiceClient =
     BrowserLanguageServiceClient.create()) {
   String name = BrowserLanguageName.of("[NETWORK_CODE]", "[BROWSER_LANGUAGE]").toString();
   BrowserLanguage response = browserLanguageServiceClient.getBrowserLanguage(name);
 }

Parameter
Name	Description
`name`	`String` Required. The resource name of the BrowserLanguage. Format: `networks/{network_code}/browserLanguages/{browser_language_id}`

Returns
Type	Description
`BrowserLanguage`

getBrowserLanguageCallable()

public final UnaryCallable<GetBrowserLanguageRequest,BrowserLanguage> getBrowserLanguageCallable()

API to retrieve a BrowserLanguage object.

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (BrowserLanguageServiceClient browserLanguageServiceClient =
     BrowserLanguageServiceClient.create()) {
   GetBrowserLanguageRequest request =
       GetBrowserLanguageRequest.newBuilder()
           .setName(BrowserLanguageName.of("[NETWORK_CODE]", "[BROWSER_LANGUAGE]").toString())
           .build();
   ApiFuture<BrowserLanguage> future =
       browserLanguageServiceClient.getBrowserLanguageCallable().futureCall(request);
   // Do something.
   BrowserLanguage response = future.get();
 }

Returns
Type	Description
`UnaryCallable<GetBrowserLanguageRequest,BrowserLanguage>`

getSettings()

public final BrowserLanguageServiceSettings getSettings()

Returns
Type	Description
`BrowserLanguageServiceSettings`

getStub()

public BrowserLanguageServiceStub getStub()

Returns
Type	Description
`BrowserLanguageServiceStub`

isShutdown()

public boolean isShutdown()

Returns
Type	Description
`boolean`

isTerminated()

public boolean isTerminated()

Returns
Type	Description
`boolean`

listBrowserLanguages(ListBrowserLanguagesRequest request)

public final BrowserLanguageServiceClient.ListBrowserLanguagesPagedResponse listBrowserLanguages(ListBrowserLanguagesRequest request)

API to retrieve a list of BrowserLanguage objects.

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (BrowserLanguageServiceClient browserLanguageServiceClient =
     BrowserLanguageServiceClient.create()) {
   ListBrowserLanguagesRequest request =
       ListBrowserLanguagesRequest.newBuilder()
           .setParent(NetworkName.of("[NETWORK_CODE]").toString())
           .setPageSize(883849137)
           .setPageToken("pageToken873572522")
           .setFilter("filter-1274492040")
           .setOrderBy("orderBy-1207110587")
           .setSkip(3532159)
           .build();
   for (BrowserLanguage element :
       browserLanguageServiceClient.listBrowserLanguages(request).iterateAll()) {
     // doThingsWith(element);
   }
 }

Parameter
Name	Description
`request`	`ListBrowserLanguagesRequest` The request object containing all of the parameters for the API call.

Returns
Type	Description
`BrowserLanguageServiceClient.ListBrowserLanguagesPagedResponse`

listBrowserLanguages(NetworkName parent)

public final BrowserLanguageServiceClient.ListBrowserLanguagesPagedResponse listBrowserLanguages(NetworkName parent)

API to retrieve a list of BrowserLanguage objects.

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (BrowserLanguageServiceClient browserLanguageServiceClient =
     BrowserLanguageServiceClient.create()) {
   NetworkName parent = NetworkName.of("[NETWORK_CODE]");
   for (BrowserLanguage element :
       browserLanguageServiceClient.listBrowserLanguages(parent).iterateAll()) {
     // doThingsWith(element);
   }
 }

Parameter
Name	Description
`parent`	`NetworkName` Required. The parent, which owns this collection of BrowserLanguages. Format: `networks/{network_code}`

Returns
Type	Description
`BrowserLanguageServiceClient.ListBrowserLanguagesPagedResponse`

listBrowserLanguages(String parent)

public final BrowserLanguageServiceClient.ListBrowserLanguagesPagedResponse listBrowserLanguages(String parent)

API to retrieve a list of BrowserLanguage objects.

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (BrowserLanguageServiceClient browserLanguageServiceClient =
     BrowserLanguageServiceClient.create()) {
   String parent = NetworkName.of("[NETWORK_CODE]").toString();
   for (BrowserLanguage element :
       browserLanguageServiceClient.listBrowserLanguages(parent).iterateAll()) {
     // doThingsWith(element);
   }
 }

Parameter
Name	Description
`parent`	`String` Required. The parent, which owns this collection of BrowserLanguages. Format: `networks/{network_code}`

Returns
Type	Description
`BrowserLanguageServiceClient.ListBrowserLanguagesPagedResponse`

listBrowserLanguagesCallable()

public final UnaryCallable<ListBrowserLanguagesRequest,ListBrowserLanguagesResponse> listBrowserLanguagesCallable()

API to retrieve a list of BrowserLanguage objects.

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (BrowserLanguageServiceClient browserLanguageServiceClient =
     BrowserLanguageServiceClient.create()) {
   ListBrowserLanguagesRequest request =
       ListBrowserLanguagesRequest.newBuilder()
           .setParent(NetworkName.of("[NETWORK_CODE]").toString())
           .setPageSize(883849137)
           .setPageToken("pageToken873572522")
           .setFilter("filter-1274492040")
           .setOrderBy("orderBy-1207110587")
           .setSkip(3532159)
           .build();
   while (true) {
     ListBrowserLanguagesResponse response =
         browserLanguageServiceClient.listBrowserLanguagesCallable().call(request);
     for (BrowserLanguage element : response.getBrowserLanguagesList()) {
       // doThingsWith(element);
     }
     String nextPageToken = response.getNextPageToken();
     if (!Strings.isNullOrEmpty(nextPageToken)) {
       request = request.toBuilder().setPageToken(nextPageToken).build();
     } else {
       break;
     }
   }
 }

Returns
Type	Description
`UnaryCallable<ListBrowserLanguagesRequest,ListBrowserLanguagesResponse>`

listBrowserLanguagesPagedCallable()

public final UnaryCallable<ListBrowserLanguagesRequest,BrowserLanguageServiceClient.ListBrowserLanguagesPagedResponse> listBrowserLanguagesPagedCallable()

API to retrieve a list of BrowserLanguage objects.

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (BrowserLanguageServiceClient browserLanguageServiceClient =
     BrowserLanguageServiceClient.create()) {
   ListBrowserLanguagesRequest request =
       ListBrowserLanguagesRequest.newBuilder()
           .setParent(NetworkName.of("[NETWORK_CODE]").toString())
           .setPageSize(883849137)
           .setPageToken("pageToken873572522")
           .setFilter("filter-1274492040")
           .setOrderBy("orderBy-1207110587")
           .setSkip(3532159)
           .build();
   ApiFuture<BrowserLanguage> future =
       browserLanguageServiceClient.listBrowserLanguagesPagedCallable().futureCall(request);
   // Do something.
   for (BrowserLanguage element : future.get().iterateAll()) {
     // doThingsWith(element);
   }
 }

Returns
Type	Description
`UnaryCallable<ListBrowserLanguagesRequest,ListBrowserLanguagesPagedResponse>`

shutdown()

public void shutdown()

shutdownNow()

public void shutdownNow()

Class BrowserLanguageServiceClient (0.39.0) Stay organized with collections Save and categorize content based on your preferences.

Inheritance

Static Methods

create()

create(BrowserLanguageServiceSettings settings)

create(BrowserLanguageServiceStub stub)

Constructors

BrowserLanguageServiceClient(BrowserLanguageServiceSettings settings)

BrowserLanguageServiceClient(BrowserLanguageServiceStub stub)

Methods

awaitTermination(long duration, TimeUnit unit)

close()

getBrowserLanguage(BrowserLanguageName name)

getBrowserLanguage(GetBrowserLanguageRequest request)

getBrowserLanguage(String name)

getBrowserLanguageCallable()

getSettings()

getStub()

isShutdown()

isTerminated()

listBrowserLanguages(ListBrowserLanguagesRequest request)

listBrowserLanguages(NetworkName parent)

listBrowserLanguages(String parent)

listBrowserLanguagesCallable()

listBrowserLanguagesPagedCallable()

shutdown()

shutdownNow()

Class BrowserLanguageServiceClient (0.39.0)