Class OperatingSystemServiceClient (0.27.0)

Service Description: Provides methods for handling OperatingSystem 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 (OperatingSystemServiceClient operatingSystemServiceClient =
     OperatingSystemServiceClient.create()) {
   OperatingSystemName name = OperatingSystemName.of("[NETWORK_CODE]", "[OPERATING_SYSTEM]");
   OperatingSystem response = operatingSystemServiceClient.getOperatingSystem(name);
 }

Note: close() needs to be called on the OperatingSystemServiceClient 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
GetOperatingSystem	API to retrieve a `OperatingSystem` object.	Request object method variants only take one parameter, a request object, which must be constructed before the call. getOperatingSystem(GetOperatingSystemRequest request) "Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method. getOperatingSystem(OperatingSystemName name) getOperatingSystem(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. getOperatingSystemCallable()
ListOperatingSystems	API to retrieve a list of `OperatingSystem` objects.	Request object method variants only take one parameter, a request object, which must be constructed before the call. listOperatingSystems(ListOperatingSystemsRequest request) "Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method. listOperatingSystems(NetworkName parent) listOperatingSystems(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. listOperatingSystemsPagedCallable() listOperatingSystemsCallable()

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 OperatingSystemServiceSettings 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
 OperatingSystemServiceSettings operatingSystemServiceSettings =
     OperatingSystemServiceSettings.newBuilder()
         .setCredentialsProvider(FixedCredentialsProvider.create(myCredentials))
         .build();
 OperatingSystemServiceClient operatingSystemServiceClient =
     OperatingSystemServiceClient.create(operatingSystemServiceSettings);

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
 OperatingSystemServiceSettings operatingSystemServiceSettings =
     OperatingSystemServiceSettings.newBuilder().setEndpoint(myEndpoint).build();
 OperatingSystemServiceClient operatingSystemServiceClient =
     OperatingSystemServiceClient.create(operatingSystemServiceSettings);

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

Inheritance

java.lang.Object > OperatingSystemServiceClient

Static Methods

create()

public static final OperatingSystemServiceClient create()

Constructs an instance of OperatingSystemServiceClient with default settings.

Returns
Type	Description
`OperatingSystemServiceClient`

Exceptions
Type	Description
`IOException`

create(OperatingSystemServiceSettings settings)

public static final OperatingSystemServiceClient create(OperatingSystemServiceSettings settings)

Constructs an instance of OperatingSystemServiceClient, 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`	`OperatingSystemServiceSettings`

Returns
Type	Description
`OperatingSystemServiceClient`

Exceptions
Type	Description
`IOException`

create(OperatingSystemServiceStub stub)

public static final OperatingSystemServiceClient create(OperatingSystemServiceStub stub)

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

Parameter
Name	Description
`stub`	`OperatingSystemServiceStub`

Returns
Type	Description
`OperatingSystemServiceClient`

Constructors

OperatingSystemServiceClient(OperatingSystemServiceSettings settings)

protected OperatingSystemServiceClient(OperatingSystemServiceSettings settings)

Constructs an instance of OperatingSystemServiceClient, 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`	`OperatingSystemServiceSettings`

OperatingSystemServiceClient(OperatingSystemServiceStub stub)

protected OperatingSystemServiceClient(OperatingSystemServiceStub stub)

Parameter
Name	Description
`stub`	`OperatingSystemServiceStub`

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

getOperatingSystem(GetOperatingSystemRequest request)

public final OperatingSystem getOperatingSystem(GetOperatingSystemRequest request)

API to retrieve a OperatingSystem 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 (OperatingSystemServiceClient operatingSystemServiceClient =
     OperatingSystemServiceClient.create()) {
   GetOperatingSystemRequest request =
       GetOperatingSystemRequest.newBuilder()
           .setName(OperatingSystemName.of("[NETWORK_CODE]", "[OPERATING_SYSTEM]").toString())
           .build();
   OperatingSystem response = operatingSystemServiceClient.getOperatingSystem(request);
 }

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

Returns
Type	Description
`OperatingSystem`

getOperatingSystem(OperatingSystemName name)

public final OperatingSystem getOperatingSystem(OperatingSystemName name)

API to retrieve a OperatingSystem 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 (OperatingSystemServiceClient operatingSystemServiceClient =
     OperatingSystemServiceClient.create()) {
   OperatingSystemName name = OperatingSystemName.of("[NETWORK_CODE]", "[OPERATING_SYSTEM]");
   OperatingSystem response = operatingSystemServiceClient.getOperatingSystem(name);
 }

Parameter
Name	Description
`name`	`OperatingSystemName` Required. The resource name of the OperatingSystem. Format: `networks/{network_code}/operatingSystems/{operating_system_id}`

Returns
Type	Description
`OperatingSystem`

getOperatingSystem(String name)

public final OperatingSystem getOperatingSystem(String name)

API to retrieve a OperatingSystem 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 (OperatingSystemServiceClient operatingSystemServiceClient =
     OperatingSystemServiceClient.create()) {
   String name = OperatingSystemName.of("[NETWORK_CODE]", "[OPERATING_SYSTEM]").toString();
   OperatingSystem response = operatingSystemServiceClient.getOperatingSystem(name);
 }

Parameter
Name	Description
`name`	`String` Required. The resource name of the OperatingSystem. Format: `networks/{network_code}/operatingSystems/{operating_system_id}`

Returns
Type	Description
`OperatingSystem`

getOperatingSystemCallable()

public final UnaryCallable<GetOperatingSystemRequest,OperatingSystem> getOperatingSystemCallable()

API to retrieve a OperatingSystem 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 (OperatingSystemServiceClient operatingSystemServiceClient =
     OperatingSystemServiceClient.create()) {
   GetOperatingSystemRequest request =
       GetOperatingSystemRequest.newBuilder()
           .setName(OperatingSystemName.of("[NETWORK_CODE]", "[OPERATING_SYSTEM]").toString())
           .build();
   ApiFuture<OperatingSystem> future =
       operatingSystemServiceClient.getOperatingSystemCallable().futureCall(request);
   // Do something.
   OperatingSystem response = future.get();
 }

Returns
Type	Description
`UnaryCallable<GetOperatingSystemRequest,OperatingSystem>`

getSettings()

public final OperatingSystemServiceSettings getSettings()

Returns
Type	Description
`OperatingSystemServiceSettings`

getStub()

public OperatingSystemServiceStub getStub()

Returns
Type	Description
`OperatingSystemServiceStub`

isShutdown()

public boolean isShutdown()

Returns
Type	Description
`boolean`

isTerminated()

public boolean isTerminated()

Returns
Type	Description
`boolean`

listOperatingSystems(ListOperatingSystemsRequest request)

public final OperatingSystemServiceClient.ListOperatingSystemsPagedResponse listOperatingSystems(ListOperatingSystemsRequest request)

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

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

Returns
Type	Description
`OperatingSystemServiceClient.ListOperatingSystemsPagedResponse`

listOperatingSystems(NetworkName parent)

public final OperatingSystemServiceClient.ListOperatingSystemsPagedResponse listOperatingSystems(NetworkName parent)

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

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

Returns
Type	Description
`OperatingSystemServiceClient.ListOperatingSystemsPagedResponse`

listOperatingSystems(String parent)

public final OperatingSystemServiceClient.ListOperatingSystemsPagedResponse listOperatingSystems(String parent)

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

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

Returns
Type	Description
`OperatingSystemServiceClient.ListOperatingSystemsPagedResponse`

listOperatingSystemsCallable()

public final UnaryCallable<ListOperatingSystemsRequest,ListOperatingSystemsResponse> listOperatingSystemsCallable()

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

Returns
Type	Description
`UnaryCallable<ListOperatingSystemsRequest,ListOperatingSystemsResponse>`

listOperatingSystemsPagedCallable()

public final UnaryCallable<ListOperatingSystemsRequest,OperatingSystemServiceClient.ListOperatingSystemsPagedResponse> listOperatingSystemsPagedCallable()

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

Returns
Type	Description
`UnaryCallable<ListOperatingSystemsRequest,ListOperatingSystemsPagedResponse>`

shutdown()

public void shutdown()

shutdownNow()

public void shutdownNow()

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

Inheritance

Static Methods

create()

create(OperatingSystemServiceSettings settings)

create(OperatingSystemServiceStub stub)

Constructors

OperatingSystemServiceClient(OperatingSystemServiceSettings settings)

OperatingSystemServiceClient(OperatingSystemServiceStub stub)

Methods

awaitTermination(long duration, TimeUnit unit)

close()

getOperatingSystem(GetOperatingSystemRequest request)

getOperatingSystem(OperatingSystemName name)

getOperatingSystem(String name)

getOperatingSystemCallable()

getSettings()

getStub()

isShutdown()

isTerminated()

listOperatingSystems(ListOperatingSystemsRequest request)

listOperatingSystems(NetworkName parent)

listOperatingSystems(String parent)

listOperatingSystemsCallable()

listOperatingSystemsPagedCallable()

shutdown()

shutdownNow()

Class OperatingSystemServiceClient (0.27.0)