Class OsConfigServiceClient (2.4.0)

public class OsConfigServiceClient implements BackgroundResource

Service Description: OS Config API

The OS Config service is a server-side component that you can use to manage package installations and patch jobs for virtual machine instances.

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:


 try (OsConfigServiceClient osConfigServiceClient = OsConfigServiceClient.create()) {
   PatchJobs.ExecutePatchJobRequest request =
       PatchJobs.ExecutePatchJobRequest.newBuilder()
           .setParent("parent-995424086")
           .setDescription("description-1724546052")
           .setInstanceFilter(PatchJobs.PatchInstanceFilter.newBuilder().build())
           .setPatchConfig(PatchJobs.PatchConfig.newBuilder().build())
           .setDuration(Duration.newBuilder().build())
           .setDryRun(true)
           .setDisplayName("displayName1714148973")
           .setRollout(PatchJobs.PatchRollout.newBuilder().build())
           .build();
   PatchJobs.PatchJob response = osConfigServiceClient.executePatchJob(request);
 }

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

The surface of this class includes several types of Java methods for each of the API's methods:

A "flattened" method. With this type of method, the fields of the request type have been converted into function parameters. It may be the case that not all fields are available as parameters, and not every API method will have a flattened method entry point.
A "request object" method. This type of method only takes one parameter, a request object, which must be constructed before the call. Not every API method will have a request object method.
A "callable" method. This type of method takes no parameters and returns an immutable API callable object, which can be used to initiate calls to the service.

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 OsConfigServiceSettings to create(). For example:

To customize credentials:


 OsConfigServiceSettings osConfigServiceSettings =
     OsConfigServiceSettings.newBuilder()
         .setCredentialsProvider(FixedCredentialsProvider.create(myCredentials))
         .build();
 OsConfigServiceClient osConfigServiceClient =
     OsConfigServiceClient.create(osConfigServiceSettings);

To customize the endpoint:


 OsConfigServiceSettings osConfigServiceSettings =
     OsConfigServiceSettings.newBuilder().setEndpoint(myEndpoint).build();
 OsConfigServiceClient osConfigServiceClient =
     OsConfigServiceClient.create(osConfigServiceSettings);

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

Inheritance

java.lang.Object > OsConfigServiceClient

Implements

BackgroundResource

Inherited Members

Object.clone()

Object.equals(Object)

Object.finalize()

Object.getClass()

Object.hashCode()

Object.notify()

Object.notifyAll()

Object.toString()

Object.wait()

Object.wait(long)

Object.wait(long,int)

Static Methods

create()

public static final OsConfigServiceClient create()

Constructs an instance of OsConfigServiceClient with default settings.

Returns

Type	Description
OsConfigServiceClient

Exceptions

Type	Description
IOException

create(OsConfigServiceSettings settings)

public static final OsConfigServiceClient create(OsConfigServiceSettings settings)

Constructs an instance of OsConfigServiceClient, 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	`OsConfigServiceSettings`

Returns

Type	Description
OsConfigServiceClient

Exceptions

Type	Description
IOException

create(OsConfigServiceStub stub)

public static final OsConfigServiceClient create(OsConfigServiceStub stub)

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

Parameter

Name	Description
stub	`OsConfigServiceStub`

Returns

Type	Description
OsConfigServiceClient

Constructors

OsConfigServiceClient(OsConfigServiceSettings settings)

protected OsConfigServiceClient(OsConfigServiceSettings settings)

Constructs an instance of OsConfigServiceClient, 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	`OsConfigServiceSettings`

OsConfigServiceClient(OsConfigServiceStub stub)

protected OsConfigServiceClient(OsConfigServiceStub stub)

Parameter

Name	Description
stub	`OsConfigServiceStub`

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

cancelPatchJob(PatchJobs.CancelPatchJobRequest request)

public final PatchJobs.PatchJob cancelPatchJob(PatchJobs.CancelPatchJobRequest request)

Cancel a patch job. The patch job must be active. Canceled patch jobs cannot be restarted.

Sample code:


 try (OsConfigServiceClient osConfigServiceClient = OsConfigServiceClient.create()) {
   PatchJobs.CancelPatchJobRequest request =
       PatchJobs.CancelPatchJobRequest.newBuilder().setName("name3373707").build();
   PatchJobs.PatchJob response = osConfigServiceClient.cancelPatchJob(request);
 }

Parameter

Name	Description
request	`PatchJobs.CancelPatchJobRequest` The request object containing all of the parameters for the API call.

Returns

Type	Description
PatchJobs.PatchJob

cancelPatchJobCallable()

public final UnaryCallable<PatchJobs.CancelPatchJobRequest,PatchJobs.PatchJob> cancelPatchJobCallable()

Cancel a patch job. The patch job must be active. Canceled patch jobs cannot be restarted.

Sample code:


 try (OsConfigServiceClient osConfigServiceClient = OsConfigServiceClient.create()) {
   PatchJobs.CancelPatchJobRequest request =
       PatchJobs.CancelPatchJobRequest.newBuilder().setName("name3373707").build();
   ApiFuture

Returns

Type	Description
UnaryCallable<CancelPatchJobRequest,PatchJob>

close()

public final void close()

createGuestPolicy(GuestPolicies.CreateGuestPolicyRequest request)

public final GuestPolicies.GuestPolicy createGuestPolicy(GuestPolicies.CreateGuestPolicyRequest request)

Create an OS Config guest policy.

Sample code:


 try (OsConfigServiceClient osConfigServiceClient = OsConfigServiceClient.create()) {
   GuestPolicies.CreateGuestPolicyRequest request =
       GuestPolicies.CreateGuestPolicyRequest.newBuilder()
           .setParent(ProjectName.of("[PROJECT]").toString())
           .setGuestPolicyId("guestPolicyId1234592741")
           .setGuestPolicy(GuestPolicies.GuestPolicy.newBuilder().build())
           .build();
   GuestPolicies.GuestPolicy response = osConfigServiceClient.createGuestPolicy(request);
 }

Parameter

Name	Description
request	`GuestPolicies.CreateGuestPolicyRequest` The request object containing all of the parameters for the API call.

Returns

Type	Description
GuestPolicies.GuestPolicy

createGuestPolicy(ProjectName parent, GuestPolicies.GuestPolicy guestPolicy)

public final GuestPolicies.GuestPolicy createGuestPolicy(ProjectName parent, GuestPolicies.GuestPolicy guestPolicy)

Create an OS Config guest policy.

Sample code:


 try (OsConfigServiceClient osConfigServiceClient = OsConfigServiceClient.create()) {
   ProjectName parent = ProjectName.of("[PROJECT]");
   GuestPolicies.GuestPolicy guestPolicy = GuestPolicies.GuestPolicy.newBuilder().build();
   GuestPolicies.GuestPolicy response =
       osConfigServiceClient.createGuestPolicy(parent, guestPolicy);
 }

Parameters

Name	Description
parent	`ProjectName` Required. The resource name of the parent using one of the following forms: `projects/{project_number}`.
guestPolicy	`GuestPolicies.GuestPolicy` Required. The GuestPolicy to create.

Returns

Type	Description
GuestPolicies.GuestPolicy

createGuestPolicy(String parent, GuestPolicies.GuestPolicy guestPolicy)

public final GuestPolicies.GuestPolicy createGuestPolicy(String parent, GuestPolicies.GuestPolicy guestPolicy)

Create an OS Config guest policy.

Sample code:


 try (OsConfigServiceClient osConfigServiceClient = OsConfigServiceClient.create()) {
   String parent = ProjectName.of("[PROJECT]").toString();
   GuestPolicies.GuestPolicy guestPolicy = GuestPolicies.GuestPolicy.newBuilder().build();
   GuestPolicies.GuestPolicy response =
       osConfigServiceClient.createGuestPolicy(parent, guestPolicy);
 }

Parameters

Name	Description
parent	`String` Required. The resource name of the parent using one of the following forms: `projects/{project_number}`.
guestPolicy	`GuestPolicies.GuestPolicy` Required. The GuestPolicy to create.

Returns

Type	Description
GuestPolicies.GuestPolicy

createGuestPolicyCallable()

public final UnaryCallable<GuestPolicies.CreateGuestPolicyRequest,GuestPolicies.GuestPolicy> createGuestPolicyCallable()

Create an OS Config guest policy.

Sample code:


 try (OsConfigServiceClient osConfigServiceClient = OsConfigServiceClient.create()) {
   GuestPolicies.CreateGuestPolicyRequest request =
       GuestPolicies.CreateGuestPolicyRequest.newBuilder()
           .setParent(ProjectName.of("[PROJECT]").toString())
           .setGuestPolicyId("guestPolicyId1234592741")
           .setGuestPolicy(GuestPolicies.GuestPolicy.newBuilder().build())
           .build();
   ApiFuture

Returns

Type	Description
UnaryCallable<CreateGuestPolicyRequest,GuestPolicy>

createPatchDeployment(PatchDeployments.CreatePatchDeploymentRequest request)

public final PatchDeployments.PatchDeployment createPatchDeployment(PatchDeployments.CreatePatchDeploymentRequest request)

Create an OS Config patch deployment.

Sample code:


 try (OsConfigServiceClient osConfigServiceClient = OsConfigServiceClient.create()) {
   PatchDeployments.CreatePatchDeploymentRequest request =
       PatchDeployments.CreatePatchDeploymentRequest.newBuilder()
           .setParent("parent-995424086")
           .setPatchDeploymentId("patchDeploymentId-1180405976")
           .setPatchDeployment(PatchDeployments.PatchDeployment.newBuilder().build())
           .build();
   PatchDeployments.PatchDeployment response =
       osConfigServiceClient.createPatchDeployment(request);
 }

Parameter

Name	Description
request	`PatchDeployments.CreatePatchDeploymentRequest` The request object containing all of the parameters for the API call.

Returns

Type	Description
PatchDeployments.PatchDeployment

createPatchDeploymentCallable()

public final UnaryCallable<PatchDeployments.CreatePatchDeploymentRequest,PatchDeployments.PatchDeployment> createPatchDeploymentCallable()

Create an OS Config patch deployment.

Sample code:


 try (OsConfigServiceClient osConfigServiceClient = OsConfigServiceClient.create()) {
   PatchDeployments.CreatePatchDeploymentRequest request =
       PatchDeployments.CreatePatchDeploymentRequest.newBuilder()
           .setParent("parent-995424086")
           .setPatchDeploymentId("patchDeploymentId-1180405976")
           .setPatchDeployment(PatchDeployments.PatchDeployment.newBuilder().build())
           .build();
   ApiFuture

Returns

Type	Description
UnaryCallable<CreatePatchDeploymentRequest,PatchDeployment>

deleteGuestPolicy(GuestPolicies.DeleteGuestPolicyRequest request)

public final void deleteGuestPolicy(GuestPolicies.DeleteGuestPolicyRequest request)

Delete an OS Config guest policy.

Sample code:


 try (OsConfigServiceClient osConfigServiceClient = OsConfigServiceClient.create()) {
   GuestPolicies.DeleteGuestPolicyRequest request =
       GuestPolicies.DeleteGuestPolicyRequest.newBuilder()
           .setName(GuestPolicyName.of("[PROJECT]", "[GUEST_POLICY]").toString())
           .build();
   osConfigServiceClient.deleteGuestPolicy(request);
 }

Parameter

Name	Description
request	`GuestPolicies.DeleteGuestPolicyRequest` The request object containing all of the parameters for the API call.

deleteGuestPolicy(GuestPolicyName name)

public final void deleteGuestPolicy(GuestPolicyName name)

Delete an OS Config guest policy.

Sample code:


 try (OsConfigServiceClient osConfigServiceClient = OsConfigServiceClient.create()) {
   GuestPolicyName name = GuestPolicyName.of("[PROJECT]", "[GUEST_POLICY]");
   osConfigServiceClient.deleteGuestPolicy(name);
 }

Parameter

Name	Description
name	`GuestPolicyName` Required. The resource name of the guest policy using one of the following forms: `projects/{project_number}/guestPolicies/{guest_policy_id}`.

deleteGuestPolicy(String name)

public final void deleteGuestPolicy(String name)

Delete an OS Config guest policy.

Sample code:


 try (OsConfigServiceClient osConfigServiceClient = OsConfigServiceClient.create()) {
   String name = GuestPolicyName.of("[PROJECT]", "[GUEST_POLICY]").toString();
   osConfigServiceClient.deleteGuestPolicy(name);
 }

Parameter

Name	Description
name	`String` Required. The resource name of the guest policy using one of the following forms: `projects/{project_number}/guestPolicies/{guest_policy_id}`.

deleteGuestPolicyCallable()

public final UnaryCallable<GuestPolicies.DeleteGuestPolicyRequest,Empty> deleteGuestPolicyCallable()

Delete an OS Config guest policy.

Sample code:


 try (OsConfigServiceClient osConfigServiceClient = OsConfigServiceClient.create()) {
   GuestPolicies.DeleteGuestPolicyRequest request =
       GuestPolicies.DeleteGuestPolicyRequest.newBuilder()
           .setName(GuestPolicyName.of("[PROJECT]", "[GUEST_POLICY]").toString())
           .build();
   ApiFuture<Empty> future =
       osConfigServiceClient.deleteGuestPolicyCallable().futureCall(request);
   // Do something.
   future.get();
 }

Returns

Type	Description
UnaryCallable<DeleteGuestPolicyRequest,Empty>

deletePatchDeployment(PatchDeployments.DeletePatchDeploymentRequest request)

public final void deletePatchDeployment(PatchDeployments.DeletePatchDeploymentRequest request)

Delete an OS Config patch deployment.

Sample code:


 try (OsConfigServiceClient osConfigServiceClient = OsConfigServiceClient.create()) {
   PatchDeployments.DeletePatchDeploymentRequest request =
       PatchDeployments.DeletePatchDeploymentRequest.newBuilder().setName("name3373707").build();
   osConfigServiceClient.deletePatchDeployment(request);
 }

Parameter

Name	Description
request	`PatchDeployments.DeletePatchDeploymentRequest` The request object containing all of the parameters for the API call.

deletePatchDeploymentCallable()

public final UnaryCallable<PatchDeployments.DeletePatchDeploymentRequest,Empty> deletePatchDeploymentCallable()

Delete an OS Config patch deployment.

Sample code:


 try (OsConfigServiceClient osConfigServiceClient = OsConfigServiceClient.create()) {
   PatchDeployments.DeletePatchDeploymentRequest request =
       PatchDeployments.DeletePatchDeploymentRequest.newBuilder().setName("name3373707").build();
   ApiFuture<Empty> future =
       osConfigServiceClient.deletePatchDeploymentCallable().futureCall(request);
   // Do something.
   future.get();
 }

Returns

Type	Description
UnaryCallable<DeletePatchDeploymentRequest,Empty>

executePatchJob(PatchJobs.ExecutePatchJobRequest request)

public final PatchJobs.PatchJob executePatchJob(PatchJobs.ExecutePatchJobRequest request)

Patch VM instances by creating and running a patch job.

Sample code:


 try (OsConfigServiceClient osConfigServiceClient = OsConfigServiceClient.create()) {
   PatchJobs.ExecutePatchJobRequest request =
       PatchJobs.ExecutePatchJobRequest.newBuilder()
           .setParent("parent-995424086")
           .setDescription("description-1724546052")
           .setInstanceFilter(PatchJobs.PatchInstanceFilter.newBuilder().build())
           .setPatchConfig(PatchJobs.PatchConfig.newBuilder().build())
           .setDuration(Duration.newBuilder().build())
           .setDryRun(true)
           .setDisplayName("displayName1714148973")
           .setRollout(PatchJobs.PatchRollout.newBuilder().build())
           .build();
   PatchJobs.PatchJob response = osConfigServiceClient.executePatchJob(request);
 }

Parameter

Name	Description
request	`PatchJobs.ExecutePatchJobRequest` The request object containing all of the parameters for the API call.

Returns

Type	Description
PatchJobs.PatchJob

executePatchJobCallable()

public final UnaryCallable<PatchJobs.ExecutePatchJobRequest,PatchJobs.PatchJob> executePatchJobCallable()

Patch VM instances by creating and running a patch job.

Sample code:


 try (OsConfigServiceClient osConfigServiceClient = OsConfigServiceClient.create()) {
   PatchJobs.ExecutePatchJobRequest request =
       PatchJobs.ExecutePatchJobRequest.newBuilder()
           .setParent("parent-995424086")
           .setDescription("description-1724546052")
           .setInstanceFilter(PatchJobs.PatchInstanceFilter.newBuilder().build())
           .setPatchConfig(PatchJobs.PatchConfig.newBuilder().build())
           .setDuration(Duration.newBuilder().build())
           .setDryRun(true)
           .setDisplayName("displayName1714148973")
           .setRollout(PatchJobs.PatchRollout.newBuilder().build())
           .build();
   ApiFuture

Returns

Type	Description
UnaryCallable<ExecutePatchJobRequest,PatchJob>

getGuestPolicy(GuestPolicies.GetGuestPolicyRequest request)

public final GuestPolicies.GuestPolicy getGuestPolicy(GuestPolicies.GetGuestPolicyRequest request)

Get an OS Config guest policy.

Sample code:


 try (OsConfigServiceClient osConfigServiceClient = OsConfigServiceClient.create()) {
   GuestPolicies.GetGuestPolicyRequest request =
       GuestPolicies.GetGuestPolicyRequest.newBuilder()
           .setName(GuestPolicyName.of("[PROJECT]", "[GUEST_POLICY]").toString())
           .build();
   GuestPolicies.GuestPolicy response = osConfigServiceClient.getGuestPolicy(request);
 }

Parameter

Name	Description
request	`GuestPolicies.GetGuestPolicyRequest` The request object containing all of the parameters for the API call.

Returns

Type	Description
GuestPolicies.GuestPolicy

getGuestPolicy(GuestPolicyName name)

public final GuestPolicies.GuestPolicy getGuestPolicy(GuestPolicyName name)

Get an OS Config guest policy.

Sample code:


 try (OsConfigServiceClient osConfigServiceClient = OsConfigServiceClient.create()) {
   GuestPolicyName name = GuestPolicyName.of("[PROJECT]", "[GUEST_POLICY]");
   GuestPolicies.GuestPolicy response = osConfigServiceClient.getGuestPolicy(name);
 }

Parameter

Name	Description
name	`GuestPolicyName` Required. The resource name of the guest policy using one of the following forms: `projects/{project_number}/guestPolicies/{guest_policy_id}`.

Returns

Type	Description
GuestPolicies.GuestPolicy

getGuestPolicy(String name)

public final GuestPolicies.GuestPolicy getGuestPolicy(String name)

Get an OS Config guest policy.

Sample code:


 try (OsConfigServiceClient osConfigServiceClient = OsConfigServiceClient.create()) {
   String name = GuestPolicyName.of("[PROJECT]", "[GUEST_POLICY]").toString();
   GuestPolicies.GuestPolicy response = osConfigServiceClient.getGuestPolicy(name);
 }

Parameter

Name	Description
name	`String` Required. The resource name of the guest policy using one of the following forms: `projects/{project_number}/guestPolicies/{guest_policy_id}`.

Returns

Type	Description
GuestPolicies.GuestPolicy

getGuestPolicyCallable()

public final UnaryCallable<GuestPolicies.GetGuestPolicyRequest,GuestPolicies.GuestPolicy> getGuestPolicyCallable()

Get an OS Config guest policy.

Sample code:


 try (OsConfigServiceClient osConfigServiceClient = OsConfigServiceClient.create()) {
   GuestPolicies.GetGuestPolicyRequest request =
       GuestPolicies.GetGuestPolicyRequest.newBuilder()
           .setName(GuestPolicyName.of("[PROJECT]", "[GUEST_POLICY]").toString())
           .build();
   ApiFuture

Returns

Type	Description
UnaryCallable<GetGuestPolicyRequest,GuestPolicy>

getPatchDeployment(PatchDeployments.GetPatchDeploymentRequest request)

public final PatchDeployments.PatchDeployment getPatchDeployment(PatchDeployments.GetPatchDeploymentRequest request)

Get an OS Config patch deployment.

Sample code:


 try (OsConfigServiceClient osConfigServiceClient = OsConfigServiceClient.create()) {
   PatchDeployments.GetPatchDeploymentRequest request =
       PatchDeployments.GetPatchDeploymentRequest.newBuilder().setName("name3373707").build();
   PatchDeployments.PatchDeployment response = osConfigServiceClient.getPatchDeployment(request);
 }

Parameter

Name	Description
request	`PatchDeployments.GetPatchDeploymentRequest` The request object containing all of the parameters for the API call.

Returns

Type	Description
PatchDeployments.PatchDeployment

getPatchDeploymentCallable()

public final UnaryCallable<PatchDeployments.GetPatchDeploymentRequest,PatchDeployments.PatchDeployment> getPatchDeploymentCallable()

Get an OS Config patch deployment.

Sample code:


 try (OsConfigServiceClient osConfigServiceClient = OsConfigServiceClient.create()) {
   PatchDeployments.GetPatchDeploymentRequest request =
       PatchDeployments.GetPatchDeploymentRequest.newBuilder().setName("name3373707").build();
   ApiFuture

Returns

Type	Description
UnaryCallable<GetPatchDeploymentRequest,PatchDeployment>

getPatchJob(PatchJobs.GetPatchJobRequest request)

public final PatchJobs.PatchJob getPatchJob(PatchJobs.GetPatchJobRequest request)

Get the patch job. This can be used to track the progress of an ongoing patch job or review the details of completed jobs.

Sample code:


 try (OsConfigServiceClient osConfigServiceClient = OsConfigServiceClient.create()) {
   PatchJobs.GetPatchJobRequest request =
       PatchJobs.GetPatchJobRequest.newBuilder().setName("name3373707").build();
   PatchJobs.PatchJob response = osConfigServiceClient.getPatchJob(request);
 }

Parameter

Name	Description
request	`PatchJobs.GetPatchJobRequest` The request object containing all of the parameters for the API call.

Returns

Type	Description
PatchJobs.PatchJob

getPatchJobCallable()

public final UnaryCallable<PatchJobs.GetPatchJobRequest,PatchJobs.PatchJob> getPatchJobCallable()

Get the patch job. This can be used to track the progress of an ongoing patch job or review the details of completed jobs.

Sample code:


 try (OsConfigServiceClient osConfigServiceClient = OsConfigServiceClient.create()) {
   PatchJobs.GetPatchJobRequest request =
       PatchJobs.GetPatchJobRequest.newBuilder().setName("name3373707").build();
   ApiFuture

Returns

Type	Description
UnaryCallable<GetPatchJobRequest,PatchJob>

getSettings()

public final OsConfigServiceSettings getSettings()

Returns

Type	Description
OsConfigServiceSettings

getStub()

public OsConfigServiceStub getStub()

Returns

Type	Description
OsConfigServiceStub

isShutdown()

public boolean isShutdown()

Returns

Type	Description
boolean

isTerminated()

public boolean isTerminated()

Returns

Type	Description
boolean

listGuestPolicies(GuestPolicies.ListGuestPoliciesRequest request)

public final OsConfigServiceClient.ListGuestPoliciesPagedResponse listGuestPolicies(GuestPolicies.ListGuestPoliciesRequest request)

Get a page of OS Config guest policies.

Sample code:


 try (OsConfigServiceClient osConfigServiceClient = OsConfigServiceClient.create()) {
   GuestPolicies.ListGuestPoliciesRequest request =
       GuestPolicies.ListGuestPoliciesRequest.newBuilder()
           .setParent(ProjectName.of("[PROJECT]").toString())
           .setPageSize(883849137)
           .setPageToken("pageToken873572522")
           .build();
   for (GuestPolicies.GuestPolicy element :
       osConfigServiceClient.listGuestPolicies(request).iterateAll()) {
     // doThingsWith(element);
   }
 }

Parameter

Name	Description
request	`GuestPolicies.ListGuestPoliciesRequest` The request object containing all of the parameters for the API call.

Returns

Type	Description
OsConfigServiceClient.ListGuestPoliciesPagedResponse

listGuestPolicies(ProjectName parent)

public final OsConfigServiceClient.ListGuestPoliciesPagedResponse listGuestPolicies(ProjectName parent)

Get a page of OS Config guest policies.

Sample code:


 try (OsConfigServiceClient osConfigServiceClient = OsConfigServiceClient.create()) {
   ProjectName parent = ProjectName.of("[PROJECT]");
   for (GuestPolicies.GuestPolicy element :
       osConfigServiceClient.listGuestPolicies(parent).iterateAll()) {
     // doThingsWith(element);
   }
 }

Parameter

Name	Description
parent	`ProjectName` Required. The resource name of the parent using one of the following forms: `projects/{project_number}`.

Returns

Type	Description
OsConfigServiceClient.ListGuestPoliciesPagedResponse

listGuestPolicies(String parent)

public final OsConfigServiceClient.ListGuestPoliciesPagedResponse listGuestPolicies(String parent)

Get a page of OS Config guest policies.

Sample code:


 try (OsConfigServiceClient osConfigServiceClient = OsConfigServiceClient.create()) {
   String parent = ProjectName.of("[PROJECT]").toString();
   for (GuestPolicies.GuestPolicy element :
       osConfigServiceClient.listGuestPolicies(parent).iterateAll()) {
     // doThingsWith(element);
   }
 }

Parameter

Name	Description
parent	`String` Required. The resource name of the parent using one of the following forms: `projects/{project_number}`.

Returns

Type	Description
OsConfigServiceClient.ListGuestPoliciesPagedResponse

listGuestPoliciesCallable()

public final UnaryCallable<GuestPolicies.ListGuestPoliciesRequest,GuestPolicies.ListGuestPoliciesResponse> listGuestPoliciesCallable()

Get a page of OS Config guest policies.

Sample code:


 try (OsConfigServiceClient osConfigServiceClient = OsConfigServiceClient.create()) {
   GuestPolicies.ListGuestPoliciesRequest request =
       GuestPolicies.ListGuestPoliciesRequest.newBuilder()
           .setParent(ProjectName.of("[PROJECT]").toString())
           .setPageSize(883849137)
           .setPageToken("pageToken873572522")
           .build();
   while (true) {
     GuestPolicies.ListGuestPoliciesResponse response =
         osConfigServiceClient.listGuestPoliciesCallable().call(request);
     for (GuestPolicies.GuestPolicy element : response.getResponsesList()) {
       // doThingsWith(element);
     }
     String nextPageToken = response.getNextPageToken();
     if (!Strings.isNullOrEmpty(nextPageToken)) {
       request = request.toBuilder().setPageToken(nextPageToken).build();
     } else {
       break;
     }
   }
 }

Returns

Type	Description
UnaryCallable<ListGuestPoliciesRequest,ListGuestPoliciesResponse>

listGuestPoliciesPagedCallable()

public final UnaryCallable<GuestPolicies.ListGuestPoliciesRequest,OsConfigServiceClient.ListGuestPoliciesPagedResponse> listGuestPoliciesPagedCallable()

Get a page of OS Config guest policies.

Sample code:


 try (OsConfigServiceClient osConfigServiceClient = OsConfigServiceClient.create()) {
   GuestPolicies.ListGuestPoliciesRequest request =
       GuestPolicies.ListGuestPoliciesRequest.newBuilder()
           .setParent(ProjectName.of("[PROJECT]").toString())
           .setPageSize(883849137)
           .setPageToken("pageToken873572522")
           .build();
   ApiFuture

Returns

Type	Description
UnaryCallable<ListGuestPoliciesRequest,ListGuestPoliciesPagedResponse>

listPatchDeployments(PatchDeployments.ListPatchDeploymentsRequest request)

public final OsConfigServiceClient.ListPatchDeploymentsPagedResponse listPatchDeployments(PatchDeployments.ListPatchDeploymentsRequest request)

Get a page of OS Config patch deployments.

Sample code:


 try (OsConfigServiceClient osConfigServiceClient = OsConfigServiceClient.create()) {
   PatchDeployments.ListPatchDeploymentsRequest request =
       PatchDeployments.ListPatchDeploymentsRequest.newBuilder()
           .setParent("parent-995424086")
           .setPageSize(883849137)
           .setPageToken("pageToken873572522")
           .build();
   for (PatchDeployments.PatchDeployment element :
       osConfigServiceClient.listPatchDeployments(request).iterateAll()) {
     // doThingsWith(element);
   }
 }

Parameter

Name	Description
request	`PatchDeployments.ListPatchDeploymentsRequest` The request object containing all of the parameters for the API call.

Returns

Type	Description
OsConfigServiceClient.ListPatchDeploymentsPagedResponse

listPatchDeploymentsCallable()

public final UnaryCallable<PatchDeployments.ListPatchDeploymentsRequest,PatchDeployments.ListPatchDeploymentsResponse> listPatchDeploymentsCallable()

Get a page of OS Config patch deployments.

Sample code:


 try (OsConfigServiceClient osConfigServiceClient = OsConfigServiceClient.create()) {
   PatchDeployments.ListPatchDeploymentsRequest request =
       PatchDeployments.ListPatchDeploymentsRequest.newBuilder()
           .setParent("parent-995424086")
           .setPageSize(883849137)
           .setPageToken("pageToken873572522")
           .build();
   while (true) {
     PatchDeployments.ListPatchDeploymentsResponse response =
         osConfigServiceClient.listPatchDeploymentsCallable().call(request);
     for (PatchDeployments.PatchDeployment element : response.getResponsesList()) {
       // doThingsWith(element);
     }
     String nextPageToken = response.getNextPageToken();
     if (!Strings.isNullOrEmpty(nextPageToken)) {
       request = request.toBuilder().setPageToken(nextPageToken).build();
     } else {
       break;
     }
   }
 }

Returns

Type	Description
UnaryCallable<ListPatchDeploymentsRequest,ListPatchDeploymentsResponse>

listPatchDeploymentsPagedCallable()

public final UnaryCallable<PatchDeployments.ListPatchDeploymentsRequest,OsConfigServiceClient.ListPatchDeploymentsPagedResponse> listPatchDeploymentsPagedCallable()

Get a page of OS Config patch deployments.

Sample code:


 try (OsConfigServiceClient osConfigServiceClient = OsConfigServiceClient.create()) {
   PatchDeployments.ListPatchDeploymentsRequest request =
       PatchDeployments.ListPatchDeploymentsRequest.newBuilder()
           .setParent("parent-995424086")
           .setPageSize(883849137)
           .setPageToken("pageToken873572522")
           .build();
   ApiFuture

Returns

Type	Description
UnaryCallable<ListPatchDeploymentsRequest,ListPatchDeploymentsPagedResponse>

listPatchJobInstanceDetails(PatchJobs.ListPatchJobInstanceDetailsRequest request)

public final OsConfigServiceClient.ListPatchJobInstanceDetailsPagedResponse listPatchJobInstanceDetails(PatchJobs.ListPatchJobInstanceDetailsRequest request)

Get a list of instance details for a given patch job.

Sample code:


 try (OsConfigServiceClient osConfigServiceClient = OsConfigServiceClient.create()) {
   PatchJobs.ListPatchJobInstanceDetailsRequest request =
       PatchJobs.ListPatchJobInstanceDetailsRequest.newBuilder()
           .setParent("parent-995424086")
           .setPageSize(883849137)
           .setPageToken("pageToken873572522")
           .setFilter("filter-1274492040")
           .build();
   for (PatchJobs.PatchJobInstanceDetails element :
       osConfigServiceClient.listPatchJobInstanceDetails(request).iterateAll()) {
     // doThingsWith(element);
   }
 }

Parameter

Name	Description
request	`PatchJobs.ListPatchJobInstanceDetailsRequest` The request object containing all of the parameters for the API call.

Returns

Type	Description
OsConfigServiceClient.ListPatchJobInstanceDetailsPagedResponse

listPatchJobInstanceDetails(String parent)

public final OsConfigServiceClient.ListPatchJobInstanceDetailsPagedResponse listPatchJobInstanceDetails(String parent)

Get a list of instance details for a given patch job.

Sample code:


 try (OsConfigServiceClient osConfigServiceClient = OsConfigServiceClient.create()) {
   String parent = "parent-995424086";
   for (PatchJobs.PatchJobInstanceDetails element :
       osConfigServiceClient.listPatchJobInstanceDetails(parent).iterateAll()) {
     // doThingsWith(element);
   }
 }

Parameter

Name	Description
parent	`String` Required. The parent for the instances are in the form of `projects//patchJobs/`.

Returns

Type	Description
OsConfigServiceClient.ListPatchJobInstanceDetailsPagedResponse

listPatchJobInstanceDetailsCallable()

public final UnaryCallable<PatchJobs.ListPatchJobInstanceDetailsRequest,PatchJobs.ListPatchJobInstanceDetailsResponse> listPatchJobInstanceDetailsCallable()

Get a list of instance details for a given patch job.

Sample code:


 try (OsConfigServiceClient osConfigServiceClient = OsConfigServiceClient.create()) {
   PatchJobs.ListPatchJobInstanceDetailsRequest request =
       PatchJobs.ListPatchJobInstanceDetailsRequest.newBuilder()
           .setParent("parent-995424086")
           .setPageSize(883849137)
           .setPageToken("pageToken873572522")
           .setFilter("filter-1274492040")
           .build();
   while (true) {
     PatchJobs.ListPatchJobInstanceDetailsResponse response =
         osConfigServiceClient.listPatchJobInstanceDetailsCallable().call(request);
     for (PatchJobs.PatchJobInstanceDetails element : response.getResponsesList()) {
       // doThingsWith(element);
     }
     String nextPageToken = response.getNextPageToken();
     if (!Strings.isNullOrEmpty(nextPageToken)) {
       request = request.toBuilder().setPageToken(nextPageToken).build();
     } else {
       break;
     }
   }
 }

Returns

Type	Description
UnaryCallable<ListPatchJobInstanceDetailsRequest,ListPatchJobInstanceDetailsResponse>

listPatchJobInstanceDetailsPagedCallable()

public final UnaryCallable<PatchJobs.ListPatchJobInstanceDetailsRequest,OsConfigServiceClient.ListPatchJobInstanceDetailsPagedResponse> listPatchJobInstanceDetailsPagedCallable()

Get a list of instance details for a given patch job.

Sample code:


 try (OsConfigServiceClient osConfigServiceClient = OsConfigServiceClient.create()) {
   PatchJobs.ListPatchJobInstanceDetailsRequest request =
       PatchJobs.ListPatchJobInstanceDetailsRequest.newBuilder()
           .setParent("parent-995424086")
           .setPageSize(883849137)
           .setPageToken("pageToken873572522")
           .setFilter("filter-1274492040")
           .build();
   ApiFuture

Returns

Type	Description
UnaryCallable<ListPatchJobInstanceDetailsRequest,ListPatchJobInstanceDetailsPagedResponse>

listPatchJobs(PatchJobs.ListPatchJobsRequest request)

public final OsConfigServiceClient.ListPatchJobsPagedResponse listPatchJobs(PatchJobs.ListPatchJobsRequest request)

Get a list of patch jobs.

Sample code:


 try (OsConfigServiceClient osConfigServiceClient = OsConfigServiceClient.create()) {
   PatchJobs.ListPatchJobsRequest request =
       PatchJobs.ListPatchJobsRequest.newBuilder()
           .setParent("parent-995424086")
           .setPageSize(883849137)
           .setPageToken("pageToken873572522")
           .setFilter("filter-1274492040")
           .build();
   for (PatchJobs.PatchJob element : osConfigServiceClient.listPatchJobs(request).iterateAll()) {
     // doThingsWith(element);
   }
 }

Parameter

Name	Description
request	`PatchJobs.ListPatchJobsRequest` The request object containing all of the parameters for the API call.

Returns

Type	Description
OsConfigServiceClient.ListPatchJobsPagedResponse

listPatchJobsCallable()

public final UnaryCallable<PatchJobs.ListPatchJobsRequest,PatchJobs.ListPatchJobsResponse> listPatchJobsCallable()

Get a list of patch jobs.

Sample code:


 try (OsConfigServiceClient osConfigServiceClient = OsConfigServiceClient.create()) {
   PatchJobs.ListPatchJobsRequest request =
       PatchJobs.ListPatchJobsRequest.newBuilder()
           .setParent("parent-995424086")
           .setPageSize(883849137)
           .setPageToken("pageToken873572522")
           .setFilter("filter-1274492040")
           .build();
   while (true) {
     PatchJobs.ListPatchJobsResponse response =
         osConfigServiceClient.listPatchJobsCallable().call(request);
     for (PatchJobs.PatchJob element : response.getResponsesList()) {
       // doThingsWith(element);
     }
     String nextPageToken = response.getNextPageToken();
     if (!Strings.isNullOrEmpty(nextPageToken)) {
       request = request.toBuilder().setPageToken(nextPageToken).build();
     } else {
       break;
     }
   }
 }

Returns

Type	Description
UnaryCallable<ListPatchJobsRequest,ListPatchJobsResponse>

listPatchJobsPagedCallable()

public final UnaryCallable<PatchJobs.ListPatchJobsRequest,OsConfigServiceClient.ListPatchJobsPagedResponse> listPatchJobsPagedCallable()

Get a list of patch jobs.

Sample code:


 try (OsConfigServiceClient osConfigServiceClient = OsConfigServiceClient.create()) {
   PatchJobs.ListPatchJobsRequest request =
       PatchJobs.ListPatchJobsRequest.newBuilder()
           .setParent("parent-995424086")
           .setPageSize(883849137)
           .setPageToken("pageToken873572522")
           .setFilter("filter-1274492040")
           .build();
   ApiFuture

Returns

Type	Description
UnaryCallable<ListPatchJobsRequest,ListPatchJobsPagedResponse>

lookupEffectiveGuestPolicy(GuestPolicies.LookupEffectiveGuestPolicyRequest request)

public final GuestPolicies.EffectiveGuestPolicy lookupEffectiveGuestPolicy(GuestPolicies.LookupEffectiveGuestPolicyRequest request)

Lookup the effective guest policy that applies to a VM instance. This lookup merges all policies that are assigned to the instance ancestry.

Sample code:


 try (OsConfigServiceClient osConfigServiceClient = OsConfigServiceClient.create()) {
   GuestPolicies.LookupEffectiveGuestPolicyRequest request =
       GuestPolicies.LookupEffectiveGuestPolicyRequest.newBuilder()
           .setInstance("instance555127957")
           .setOsShortName("osShortName1253394339")
           .setOsVersion("osVersion1812004436")
           .setOsArchitecture("osArchitecture1339954519")
           .build();
   GuestPolicies.EffectiveGuestPolicy response =
       osConfigServiceClient.lookupEffectiveGuestPolicy(request);
 }

Parameter

Name	Description
request	`GuestPolicies.LookupEffectiveGuestPolicyRequest` The request object containing all of the parameters for the API call.

Returns

Type	Description
GuestPolicies.EffectiveGuestPolicy

lookupEffectiveGuestPolicyCallable()

public final UnaryCallable<GuestPolicies.LookupEffectiveGuestPolicyRequest,GuestPolicies.EffectiveGuestPolicy> lookupEffectiveGuestPolicyCallable()

Lookup the effective guest policy that applies to a VM instance. This lookup merges all policies that are assigned to the instance ancestry.

Sample code:


 try (OsConfigServiceClient osConfigServiceClient = OsConfigServiceClient.create()) {
   GuestPolicies.LookupEffectiveGuestPolicyRequest request =
       GuestPolicies.LookupEffectiveGuestPolicyRequest.newBuilder()
           .setInstance("instance555127957")
           .setOsShortName("osShortName1253394339")
           .setOsVersion("osVersion1812004436")
           .setOsArchitecture("osArchitecture1339954519")
           .build();
   ApiFuture

Returns

Type	Description
UnaryCallable<LookupEffectiveGuestPolicyRequest,EffectiveGuestPolicy>

pausePatchDeployment(PatchDeploymentName name)

public final PatchDeployments.PatchDeployment pausePatchDeployment(PatchDeploymentName name)

Change state of patch deployment to "PAUSED". Patch deployment in paused state doesn't generate patch jobs.

Sample code:


 try (OsConfigServiceClient osConfigServiceClient = OsConfigServiceClient.create()) {
   PatchDeploymentName name = PatchDeploymentName.of("[PROJECT]", "[PATCH_DEPLOYMENT]");
   PatchDeployments.PatchDeployment response = osConfigServiceClient.pausePatchDeployment(name);
 }

Parameter

Name	Description
name	`PatchDeploymentName` Required. The resource name of the patch deployment in the form `projects//patchDeployments/`.

Returns

Type	Description
PatchDeployments.PatchDeployment

pausePatchDeployment(PatchDeployments.PausePatchDeploymentRequest request)

public final PatchDeployments.PatchDeployment pausePatchDeployment(PatchDeployments.PausePatchDeploymentRequest request)

Change state of patch deployment to "PAUSED". Patch deployment in paused state doesn't generate patch jobs.

Sample code:


 try (OsConfigServiceClient osConfigServiceClient = OsConfigServiceClient.create()) {
   PatchDeployments.PausePatchDeploymentRequest request =
       PatchDeployments.PausePatchDeploymentRequest.newBuilder()
           .setName(PatchDeploymentName.of("[PROJECT]", "[PATCH_DEPLOYMENT]").toString())
           .build();
   PatchDeployments.PatchDeployment response =
       osConfigServiceClient.pausePatchDeployment(request);
 }

Parameter

Name	Description
request	`PatchDeployments.PausePatchDeploymentRequest` The request object containing all of the parameters for the API call.

Returns

Type	Description
PatchDeployments.PatchDeployment

pausePatchDeployment(String name)

public final PatchDeployments.PatchDeployment pausePatchDeployment(String name)

Change state of patch deployment to "PAUSED". Patch deployment in paused state doesn't generate patch jobs.

Sample code:


 try (OsConfigServiceClient osConfigServiceClient = OsConfigServiceClient.create()) {
   String name = PatchDeploymentName.of("[PROJECT]", "[PATCH_DEPLOYMENT]").toString();
   PatchDeployments.PatchDeployment response = osConfigServiceClient.pausePatchDeployment(name);
 }

Parameter

Name	Description
name	`String` Required. The resource name of the patch deployment in the form `projects//patchDeployments/`.

Returns

Type	Description
PatchDeployments.PatchDeployment

pausePatchDeploymentCallable()

public final UnaryCallable<PatchDeployments.PausePatchDeploymentRequest,PatchDeployments.PatchDeployment> pausePatchDeploymentCallable()

Change state of patch deployment to "PAUSED". Patch deployment in paused state doesn't generate patch jobs.

Sample code:


 try (OsConfigServiceClient osConfigServiceClient = OsConfigServiceClient.create()) {
   PatchDeployments.PausePatchDeploymentRequest request =
       PatchDeployments.PausePatchDeploymentRequest.newBuilder()
           .setName(PatchDeploymentName.of("[PROJECT]", "[PATCH_DEPLOYMENT]").toString())
           .build();
   ApiFuture

Returns

Type	Description
UnaryCallable<PausePatchDeploymentRequest,PatchDeployment>

resumePatchDeployment(PatchDeploymentName name)

public final PatchDeployments.PatchDeployment resumePatchDeployment(PatchDeploymentName name)

Change state of patch deployment back to "ACTIVE". Patch deployment in active state continues to generate patch jobs.

Sample code:


 try (OsConfigServiceClient osConfigServiceClient = OsConfigServiceClient.create()) {
   PatchDeploymentName name = PatchDeploymentName.of("[PROJECT]", "[PATCH_DEPLOYMENT]");
   PatchDeployments.PatchDeployment response = osConfigServiceClient.resumePatchDeployment(name);
 }

Parameter

Name	Description
name	`PatchDeploymentName` Required. The resource name of the patch deployment in the form `projects//patchDeployments/`.

Returns

Type	Description
PatchDeployments.PatchDeployment

resumePatchDeployment(PatchDeployments.ResumePatchDeploymentRequest request)

public final PatchDeployments.PatchDeployment resumePatchDeployment(PatchDeployments.ResumePatchDeploymentRequest request)

Change state of patch deployment back to "ACTIVE". Patch deployment in active state continues to generate patch jobs.

Sample code:


 try (OsConfigServiceClient osConfigServiceClient = OsConfigServiceClient.create()) {
   PatchDeployments.ResumePatchDeploymentRequest request =
       PatchDeployments.ResumePatchDeploymentRequest.newBuilder()
           .setName(PatchDeploymentName.of("[PROJECT]", "[PATCH_DEPLOYMENT]").toString())
           .build();
   PatchDeployments.PatchDeployment response =
       osConfigServiceClient.resumePatchDeployment(request);
 }

Parameter

Name	Description
request	`PatchDeployments.ResumePatchDeploymentRequest` The request object containing all of the parameters for the API call.

Returns

Type	Description
PatchDeployments.PatchDeployment

resumePatchDeployment(String name)

public final PatchDeployments.PatchDeployment resumePatchDeployment(String name)

Change state of patch deployment back to "ACTIVE". Patch deployment in active state continues to generate patch jobs.

Sample code:


 try (OsConfigServiceClient osConfigServiceClient = OsConfigServiceClient.create()) {
   String name = PatchDeploymentName.of("[PROJECT]", "[PATCH_DEPLOYMENT]").toString();
   PatchDeployments.PatchDeployment response = osConfigServiceClient.resumePatchDeployment(name);
 }

Parameter

Name	Description
name	`String` Required. The resource name of the patch deployment in the form `projects//patchDeployments/`.

Returns

Type	Description
PatchDeployments.PatchDeployment

resumePatchDeploymentCallable()

public final UnaryCallable<PatchDeployments.ResumePatchDeploymentRequest,PatchDeployments.PatchDeployment> resumePatchDeploymentCallable()

Change state of patch deployment back to "ACTIVE". Patch deployment in active state continues to generate patch jobs.

Sample code:


 try (OsConfigServiceClient osConfigServiceClient = OsConfigServiceClient.create()) {
   PatchDeployments.ResumePatchDeploymentRequest request =
       PatchDeployments.ResumePatchDeploymentRequest.newBuilder()
           .setName(PatchDeploymentName.of("[PROJECT]", "[PATCH_DEPLOYMENT]").toString())
           .build();
   ApiFuture

Returns

Type	Description
UnaryCallable<ResumePatchDeploymentRequest,PatchDeployment>

shutdown()

public void shutdown()

shutdownNow()

public void shutdownNow()

updateGuestPolicy(GuestPolicies.GuestPolicy guestPolicy, FieldMask updateMask)

public final GuestPolicies.GuestPolicy updateGuestPolicy(GuestPolicies.GuestPolicy guestPolicy, FieldMask updateMask)

Update an OS Config guest policy.

Sample code:


 try (OsConfigServiceClient osConfigServiceClient = OsConfigServiceClient.create()) {
   GuestPolicies.GuestPolicy guestPolicy = GuestPolicies.GuestPolicy.newBuilder().build();
   FieldMask updateMask = FieldMask.newBuilder().build();
   GuestPolicies.GuestPolicy response =
       osConfigServiceClient.updateGuestPolicy(guestPolicy, updateMask);
 }

Parameters

Name	Description
guestPolicy	`GuestPolicies.GuestPolicy` Required. The updated GuestPolicy.
updateMask	`FieldMask` Field mask that controls which fields of the guest policy should be updated.

Returns

Type	Description
GuestPolicies.GuestPolicy

updateGuestPolicy(GuestPolicies.UpdateGuestPolicyRequest request)

public final GuestPolicies.GuestPolicy updateGuestPolicy(GuestPolicies.UpdateGuestPolicyRequest request)

Update an OS Config guest policy.

Sample code:


 try (OsConfigServiceClient osConfigServiceClient = OsConfigServiceClient.create()) {
   GuestPolicies.UpdateGuestPolicyRequest request =
       GuestPolicies.UpdateGuestPolicyRequest.newBuilder()
           .setGuestPolicy(GuestPolicies.GuestPolicy.newBuilder().build())
           .setUpdateMask(FieldMask.newBuilder().build())
           .build();
   GuestPolicies.GuestPolicy response = osConfigServiceClient.updateGuestPolicy(request);
 }

Parameter

Name	Description
request	`GuestPolicies.UpdateGuestPolicyRequest` The request object containing all of the parameters for the API call.

Returns

Type	Description
GuestPolicies.GuestPolicy

updateGuestPolicyCallable()

public final UnaryCallable<GuestPolicies.UpdateGuestPolicyRequest,GuestPolicies.GuestPolicy> updateGuestPolicyCallable()

Update an OS Config guest policy.

Sample code:


 try (OsConfigServiceClient osConfigServiceClient = OsConfigServiceClient.create()) {
   GuestPolicies.UpdateGuestPolicyRequest request =
       GuestPolicies.UpdateGuestPolicyRequest.newBuilder()
           .setGuestPolicy(GuestPolicies.GuestPolicy.newBuilder().build())
           .setUpdateMask(FieldMask.newBuilder().build())
           .build();
   ApiFuture

Returns

Type	Description
UnaryCallable<UpdateGuestPolicyRequest,GuestPolicy>

updatePatchDeployment(PatchDeployments.PatchDeployment patchDeployment, FieldMask updateMask)

public final PatchDeployments.PatchDeployment updatePatchDeployment(PatchDeployments.PatchDeployment patchDeployment, FieldMask updateMask)

Update an OS Config patch deployment.

Sample code:


 try (OsConfigServiceClient osConfigServiceClient = OsConfigServiceClient.create()) {
   PatchDeployments.PatchDeployment patchDeployment =
       PatchDeployments.PatchDeployment.newBuilder().build();
   FieldMask updateMask = FieldMask.newBuilder().build();
   PatchDeployments.PatchDeployment response =
       osConfigServiceClient.updatePatchDeployment(patchDeployment, updateMask);
 }

Parameters

Name	Description
patchDeployment	`PatchDeployments.PatchDeployment` Required. The patch deployment to Update.
updateMask	`FieldMask` Optional. Field mask that controls which fields of the patch deployment should be updated.

Returns

Type	Description
PatchDeployments.PatchDeployment

updatePatchDeployment(PatchDeployments.UpdatePatchDeploymentRequest request)

public final PatchDeployments.PatchDeployment updatePatchDeployment(PatchDeployments.UpdatePatchDeploymentRequest request)

Update an OS Config patch deployment.

Sample code:


 try (OsConfigServiceClient osConfigServiceClient = OsConfigServiceClient.create()) {
   PatchDeployments.UpdatePatchDeploymentRequest request =
       PatchDeployments.UpdatePatchDeploymentRequest.newBuilder()
           .setPatchDeployment(PatchDeployments.PatchDeployment.newBuilder().build())
           .setUpdateMask(FieldMask.newBuilder().build())
           .build();
   PatchDeployments.PatchDeployment response =
       osConfigServiceClient.updatePatchDeployment(request);
 }

Parameter

Name	Description
request	`PatchDeployments.UpdatePatchDeploymentRequest` The request object containing all of the parameters for the API call.

Returns

Type	Description
PatchDeployments.PatchDeployment

updatePatchDeploymentCallable()

public final UnaryCallable<PatchDeployments.UpdatePatchDeploymentRequest,PatchDeployments.PatchDeployment> updatePatchDeploymentCallable()

Update an OS Config patch deployment.

Sample code:


 try (OsConfigServiceClient osConfigServiceClient = OsConfigServiceClient.create()) {
   PatchDeployments.UpdatePatchDeploymentRequest request =
       PatchDeployments.UpdatePatchDeploymentRequest.newBuilder()
           .setPatchDeployment(PatchDeployments.PatchDeployment.newBuilder().build())
           .setUpdateMask(FieldMask.newBuilder().build())
           .build();
   ApiFuture

Returns

Type	Description
UnaryCallable<UpdatePatchDeploymentRequest,PatchDeployment>