Class OperatingSystemVersionServiceClient (0.27.0)

Service Description: Provides methods for handling OperatingSystemVersion 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 (OperatingSystemVersionServiceClient operatingSystemVersionServiceClient =
     OperatingSystemVersionServiceClient.create()) {
   OperatingSystemVersionName name =
       OperatingSystemVersionName.of("[NETWORK_CODE]", "[OPERATING_SYSTEM_VERSION]");
   OperatingSystemVersion response =
       operatingSystemVersionServiceClient.getOperatingSystemVersion(name);
 }

Note: close() needs to be called on the OperatingSystemVersionServiceClient 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
GetOperatingSystemVersion	API to retrieve a `OperatingSystemVersion` object.	Request object method variants only take one parameter, a request object, which must be constructed before the call. getOperatingSystemVersion(GetOperatingSystemVersionRequest request) "Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method. getOperatingSystemVersion(OperatingSystemVersionName name) getOperatingSystemVersion(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. getOperatingSystemVersionCallable()
ListOperatingSystemVersions	API to retrieve a list of `OperatingSystemVersion` objects.	Request object method variants only take one parameter, a request object, which must be constructed before the call. listOperatingSystemVersions(ListOperatingSystemVersionsRequest request) "Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method. listOperatingSystemVersions(NetworkName parent) listOperatingSystemVersions(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. listOperatingSystemVersionsPagedCallable() listOperatingSystemVersionsCallable()

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 OperatingSystemVersionServiceSettings 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
 OperatingSystemVersionServiceSettings operatingSystemVersionServiceSettings =
     OperatingSystemVersionServiceSettings.newBuilder()
         .setCredentialsProvider(FixedCredentialsProvider.create(myCredentials))
         .build();
 OperatingSystemVersionServiceClient operatingSystemVersionServiceClient =
     OperatingSystemVersionServiceClient.create(operatingSystemVersionServiceSettings);

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
 OperatingSystemVersionServiceSettings operatingSystemVersionServiceSettings =
     OperatingSystemVersionServiceSettings.newBuilder().setEndpoint(myEndpoint).build();
 OperatingSystemVersionServiceClient operatingSystemVersionServiceClient =
     OperatingSystemVersionServiceClient.create(operatingSystemVersionServiceSettings);

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

Inheritance

java.lang.Object > OperatingSystemVersionServiceClient

Static Methods

create()

public static final OperatingSystemVersionServiceClient create()

Constructs an instance of OperatingSystemVersionServiceClient with default settings.

Returns
Type	Description
`OperatingSystemVersionServiceClient`

Exceptions
Type	Description
`IOException`

create(OperatingSystemVersionServiceSettings settings)

public static final OperatingSystemVersionServiceClient create(OperatingSystemVersionServiceSettings settings)

Constructs an instance of OperatingSystemVersionServiceClient, 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`	`OperatingSystemVersionServiceSettings`

Returns
Type	Description
`OperatingSystemVersionServiceClient`

Exceptions
Type	Description
`IOException`

create(OperatingSystemVersionServiceStub stub)

public static final OperatingSystemVersionServiceClient create(OperatingSystemVersionServiceStub stub)

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

Parameter
Name	Description
`stub`	`OperatingSystemVersionServiceStub`

Returns
Type	Description
`OperatingSystemVersionServiceClient`

Constructors

OperatingSystemVersionServiceClient(OperatingSystemVersionServiceSettings settings)

protected OperatingSystemVersionServiceClient(OperatingSystemVersionServiceSettings settings)

Constructs an instance of OperatingSystemVersionServiceClient, 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`	`OperatingSystemVersionServiceSettings`

OperatingSystemVersionServiceClient(OperatingSystemVersionServiceStub stub)

protected OperatingSystemVersionServiceClient(OperatingSystemVersionServiceStub stub)

Parameter
Name	Description
`stub`	`OperatingSystemVersionServiceStub`

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()

getOperatingSystemVersion(GetOperatingSystemVersionRequest request)

public final OperatingSystemVersion getOperatingSystemVersion(GetOperatingSystemVersionRequest request)

API to retrieve a OperatingSystemVersion 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 (OperatingSystemVersionServiceClient operatingSystemVersionServiceClient =
     OperatingSystemVersionServiceClient.create()) {
   GetOperatingSystemVersionRequest request =
       GetOperatingSystemVersionRequest.newBuilder()
           .setName(
               OperatingSystemVersionName.of("[NETWORK_CODE]", "[OPERATING_SYSTEM_VERSION]")
                   .toString())
           .build();
   OperatingSystemVersion response =
       operatingSystemVersionServiceClient.getOperatingSystemVersion(request);
 }

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

Returns
Type	Description
`OperatingSystemVersion`

getOperatingSystemVersion(OperatingSystemVersionName name)

public final OperatingSystemVersion getOperatingSystemVersion(OperatingSystemVersionName name)

API to retrieve a OperatingSystemVersion 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 (OperatingSystemVersionServiceClient operatingSystemVersionServiceClient =
     OperatingSystemVersionServiceClient.create()) {
   OperatingSystemVersionName name =
       OperatingSystemVersionName.of("[NETWORK_CODE]", "[OPERATING_SYSTEM_VERSION]");
   OperatingSystemVersion response =
       operatingSystemVersionServiceClient.getOperatingSystemVersion(name);
 }

Parameter
Name	Description
`name`	`OperatingSystemVersionName` Required. The resource name of the OperatingSystemVersion. Format: `networks/{network_code}/operatingSystemVersions/{operating_system_version_id}`

Returns
Type	Description
`OperatingSystemVersion`

getOperatingSystemVersion(String name)

public final OperatingSystemVersion getOperatingSystemVersion(String name)

API to retrieve a OperatingSystemVersion 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 (OperatingSystemVersionServiceClient operatingSystemVersionServiceClient =
     OperatingSystemVersionServiceClient.create()) {
   String name =
       OperatingSystemVersionName.of("[NETWORK_CODE]", "[OPERATING_SYSTEM_VERSION]").toString();
   OperatingSystemVersion response =
       operatingSystemVersionServiceClient.getOperatingSystemVersion(name);
 }

Parameter
Name	Description
`name`	`String` Required. The resource name of the OperatingSystemVersion. Format: `networks/{network_code}/operatingSystemVersions/{operating_system_version_id}`

Returns
Type	Description
`OperatingSystemVersion`

getOperatingSystemVersionCallable()

public final UnaryCallable<GetOperatingSystemVersionRequest,OperatingSystemVersion> getOperatingSystemVersionCallable()

API to retrieve a OperatingSystemVersion 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 (OperatingSystemVersionServiceClient operatingSystemVersionServiceClient =
     OperatingSystemVersionServiceClient.create()) {
   GetOperatingSystemVersionRequest request =
       GetOperatingSystemVersionRequest.newBuilder()
           .setName(
               OperatingSystemVersionName.of("[NETWORK_CODE]", "[OPERATING_SYSTEM_VERSION]")
                   .toString())
           .build();
   ApiFuture<OperatingSystemVersion> future =
       operatingSystemVersionServiceClient
           .getOperatingSystemVersionCallable()
           .futureCall(request);
   // Do something.
   OperatingSystemVersion response = future.get();
 }

Returns
Type	Description
`UnaryCallable<GetOperatingSystemVersionRequest,OperatingSystemVersion>`

getSettings()

public final OperatingSystemVersionServiceSettings getSettings()

Returns
Type	Description
`OperatingSystemVersionServiceSettings`

getStub()

public OperatingSystemVersionServiceStub getStub()

Returns
Type	Description
`OperatingSystemVersionServiceStub`

isShutdown()

public boolean isShutdown()

Returns
Type	Description
`boolean`

isTerminated()

public boolean isTerminated()

Returns
Type	Description
`boolean`

listOperatingSystemVersions(ListOperatingSystemVersionsRequest request)

public final OperatingSystemVersionServiceClient.ListOperatingSystemVersionsPagedResponse listOperatingSystemVersions(ListOperatingSystemVersionsRequest request)

API to retrieve a list of OperatingSystemVersion 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 (OperatingSystemVersionServiceClient operatingSystemVersionServiceClient =
     OperatingSystemVersionServiceClient.create()) {
   ListOperatingSystemVersionsRequest request =
       ListOperatingSystemVersionsRequest.newBuilder()
           .setParent(NetworkName.of("[NETWORK_CODE]").toString())
           .setPageSize(883849137)
           .setPageToken("pageToken873572522")
           .setFilter("filter-1274492040")
           .setOrderBy("orderBy-1207110587")
           .setSkip(3532159)
           .build();
   for (OperatingSystemVersion element :
       operatingSystemVersionServiceClient.listOperatingSystemVersions(request).iterateAll()) {
     // doThingsWith(element);
   }
 }

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

Returns
Type	Description
`OperatingSystemVersionServiceClient.ListOperatingSystemVersionsPagedResponse`

listOperatingSystemVersions(NetworkName parent)

public final OperatingSystemVersionServiceClient.ListOperatingSystemVersionsPagedResponse listOperatingSystemVersions(NetworkName parent)

API to retrieve a list of OperatingSystemVersion 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 (OperatingSystemVersionServiceClient operatingSystemVersionServiceClient =
     OperatingSystemVersionServiceClient.create()) {
   NetworkName parent = NetworkName.of("[NETWORK_CODE]");
   for (OperatingSystemVersion element :
       operatingSystemVersionServiceClient.listOperatingSystemVersions(parent).iterateAll()) {
     // doThingsWith(element);
   }
 }

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

Returns
Type	Description
`OperatingSystemVersionServiceClient.ListOperatingSystemVersionsPagedResponse`

listOperatingSystemVersions(String parent)

public final OperatingSystemVersionServiceClient.ListOperatingSystemVersionsPagedResponse listOperatingSystemVersions(String parent)

API to retrieve a list of OperatingSystemVersion 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 (OperatingSystemVersionServiceClient operatingSystemVersionServiceClient =
     OperatingSystemVersionServiceClient.create()) {
   String parent = NetworkName.of("[NETWORK_CODE]").toString();
   for (OperatingSystemVersion element :
       operatingSystemVersionServiceClient.listOperatingSystemVersions(parent).iterateAll()) {
     // doThingsWith(element);
   }
 }

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

Returns
Type	Description
`OperatingSystemVersionServiceClient.ListOperatingSystemVersionsPagedResponse`

listOperatingSystemVersionsCallable()

public final UnaryCallable<ListOperatingSystemVersionsRequest,ListOperatingSystemVersionsResponse> listOperatingSystemVersionsCallable()

API to retrieve a list of OperatingSystemVersion 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 (OperatingSystemVersionServiceClient operatingSystemVersionServiceClient =
     OperatingSystemVersionServiceClient.create()) {
   ListOperatingSystemVersionsRequest request =
       ListOperatingSystemVersionsRequest.newBuilder()
           .setParent(NetworkName.of("[NETWORK_CODE]").toString())
           .setPageSize(883849137)
           .setPageToken("pageToken873572522")
           .setFilter("filter-1274492040")
           .setOrderBy("orderBy-1207110587")
           .setSkip(3532159)
           .build();
   while (true) {
     ListOperatingSystemVersionsResponse response =
         operatingSystemVersionServiceClient.listOperatingSystemVersionsCallable().call(request);
     for (OperatingSystemVersion element : response.getOperatingSystemVersionsList()) {
       // doThingsWith(element);
     }
     String nextPageToken = response.getNextPageToken();
     if (!Strings.isNullOrEmpty(nextPageToken)) {
       request = request.toBuilder().setPageToken(nextPageToken).build();
     } else {
       break;
     }
   }
 }

Returns
Type	Description
`UnaryCallable<ListOperatingSystemVersionsRequest,ListOperatingSystemVersionsResponse>`

listOperatingSystemVersionsPagedCallable()

public final UnaryCallable<ListOperatingSystemVersionsRequest,OperatingSystemVersionServiceClient.ListOperatingSystemVersionsPagedResponse> listOperatingSystemVersionsPagedCallable()

API to retrieve a list of OperatingSystemVersion 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 (OperatingSystemVersionServiceClient operatingSystemVersionServiceClient =
     OperatingSystemVersionServiceClient.create()) {
   ListOperatingSystemVersionsRequest request =
       ListOperatingSystemVersionsRequest.newBuilder()
           .setParent(NetworkName.of("[NETWORK_CODE]").toString())
           .setPageSize(883849137)
           .setPageToken("pageToken873572522")
           .setFilter("filter-1274492040")
           .setOrderBy("orderBy-1207110587")
           .setSkip(3532159)
           .build();
   ApiFuture<OperatingSystemVersion> future =
       operatingSystemVersionServiceClient
           .listOperatingSystemVersionsPagedCallable()
           .futureCall(request);
   // Do something.
   for (OperatingSystemVersion element : future.get().iterateAll()) {
     // doThingsWith(element);
   }
 }

Returns
Type	Description
`UnaryCallable<ListOperatingSystemVersionsRequest,ListOperatingSystemVersionsPagedResponse>`

shutdown()

public void shutdown()

shutdownNow()

public void shutdownNow()

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

Inheritance

Static Methods

create()

create(OperatingSystemVersionServiceSettings settings)

create(OperatingSystemVersionServiceStub stub)

Constructors

OperatingSystemVersionServiceClient(OperatingSystemVersionServiceSettings settings)

OperatingSystemVersionServiceClient(OperatingSystemVersionServiceStub stub)

Methods

awaitTermination(long duration, TimeUnit unit)

close()

getOperatingSystemVersion(GetOperatingSystemVersionRequest request)

getOperatingSystemVersion(OperatingSystemVersionName name)

getOperatingSystemVersion(String name)

getOperatingSystemVersionCallable()

getSettings()

getStub()

isShutdown()

isTerminated()

listOperatingSystemVersions(ListOperatingSystemVersionsRequest request)

listOperatingSystemVersions(NetworkName parent)

listOperatingSystemVersions(String parent)

listOperatingSystemVersionsCallable()

listOperatingSystemVersionsPagedCallable()

shutdown()

shutdownNow()

Class OperatingSystemVersionServiceClient (0.27.0)