@BetaApi @Generated(value="by gapic-generator-java") public class OsConfigServiceClient extends Object implements com.google.api.gax.core.BackgroundResource
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:
// 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 (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().
| Method | Description | Method Variants |
|---|---|---|
| ExecutePatchJob | Patch VM instances by creating and running a patch job. |
Request object method variants only take one parameter, a request object, which must be constructed before the call.
Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.
|
| GetPatchJob | Get the patch job. This can be used to track the progress of an ongoing patch job or review the details of completed jobs. |
Request object method variants only take one parameter, a request object, which must be constructed before the call.
Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.
|
| CancelPatchJob | Cancel a patch job. The patch job must be active. Canceled patch jobs cannot be restarted. |
Request object method variants only take one parameter, a request object, which must be constructed before the call.
Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.
|
| ListPatchJobs | Get a list of patch jobs. |
Request object method variants only take one parameter, a request object, which must be constructed before the call.
Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.
|
| ListPatchJobInstanceDetails | Get a list of instance details for a given patch job. |
Request object method variants only take one parameter, a request object, which must be constructed before the call.
"Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method.
Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.
|
| CreatePatchDeployment | Create an OS Config patch deployment. |
Request object method variants only take one parameter, a request object, which must be constructed before the call.
Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.
|
| GetPatchDeployment | Get an OS Config patch deployment. |
Request object method variants only take one parameter, a request object, which must be constructed before the call.
Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.
|
| ListPatchDeployments | Get a page of OS Config patch deployments. |
Request object method variants only take one parameter, a request object, which must be constructed before the call.
Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.
|
| DeletePatchDeployment | Delete an OS Config patch deployment. |
Request object method variants only take one parameter, a request object, which must be constructed before the call.
Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.
|
| UpdatePatchDeployment | Update an OS Config patch deployment. |
Request object method variants only take one parameter, a request object, which must be constructed before the call.
"Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method.
Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.
|
| PausePatchDeployment | Change state of patch deployment to "PAUSED". Patch deployment in paused state doesn't generate patch jobs. |
Request object method variants only take one parameter, a request object, which must be constructed before the call.
"Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method.
Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.
|
| ResumePatchDeployment | Change state of patch deployment back to "ACTIVE". Patch deployment in active state continues to generate patch jobs. |
Request object method variants only take one parameter, a request object, which must be constructed before the call.
"Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method.
Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.
|
| CreateGuestPolicy | Create an OS Config guest policy. |
Request object method variants only take one parameter, a request object, which must be constructed before the call.
"Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method.
Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.
|
| GetGuestPolicy | Get an OS Config guest policy. |
Request object method variants only take one parameter, a request object, which must be constructed before the call.
"Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method.
Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.
|
| ListGuestPolicies | Get a page of OS Config guest policies. |
Request object method variants only take one parameter, a request object, which must be constructed before the call.
"Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method.
Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.
|
| UpdateGuestPolicy | Update an OS Config guest policy. |
Request object method variants only take one parameter, a request object, which must be constructed before the call.
"Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method.
Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.
|
| DeleteGuestPolicy | Delete an OS Config guest policy. |
Request object method variants only take one parameter, a request object, which must be constructed before the call.
"Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method.
Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.
|
| LookupEffectiveGuestPolicy | Lookup the effective guest policy that applies to a VM instance. This lookup merges all policies that are assigned to the instance ancestry. |
Request object method variants only take one parameter, a request object, which must be constructed before the call.
Callable method variants take no parameters and return 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:
// 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
OsConfigServiceSettings osConfigServiceSettings =
OsConfigServiceSettings.newBuilder()
.setCredentialsProvider(FixedCredentialsProvider.create(myCredentials))
.build();
OsConfigServiceClient osConfigServiceClient =
OsConfigServiceClient.create(osConfigServiceSettings);
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
OsConfigServiceSettings osConfigServiceSettings =
OsConfigServiceSettings.newBuilder().setEndpoint(myEndpoint).build();
OsConfigServiceClient osConfigServiceClient =
OsConfigServiceClient.create(osConfigServiceSettings);
To use REST (HTTP1.1/JSON) transport (instead of gRPC) for sending and receiving requests over the wire:
// 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
OsConfigServiceSettings osConfigServiceSettings =
OsConfigServiceSettings.newHttpJsonBuilder().build();
OsConfigServiceClient osConfigServiceClient =
OsConfigServiceClient.create(osConfigServiceSettings);
Please refer to the GitHub repository's samples for more quickstart code snippets.
| Modifier and Type | Class and Description |
|---|---|
static class |
OsConfigServiceClient.ListGuestPoliciesFixedSizeCollection |
static class |
OsConfigServiceClient.ListGuestPoliciesPage |
static class |
OsConfigServiceClient.ListGuestPoliciesPagedResponse |
static class |
OsConfigServiceClient.ListPatchDeploymentsFixedSizeCollection |
static class |
OsConfigServiceClient.ListPatchDeploymentsPage |
static class |
OsConfigServiceClient.ListPatchDeploymentsPagedResponse |
static class |
OsConfigServiceClient.ListPatchJobInstanceDetailsFixedSizeCollection |
static class |
OsConfigServiceClient.ListPatchJobInstanceDetailsPage |
static class |
OsConfigServiceClient.ListPatchJobInstanceDetailsPagedResponse |
static class |
OsConfigServiceClient.ListPatchJobsFixedSizeCollection |
static class |
OsConfigServiceClient.ListPatchJobsPage |
static class |
OsConfigServiceClient.ListPatchJobsPagedResponse |
| Modifier | Constructor and Description |
|---|---|
protected |
OsConfigServiceClient(OsConfigServiceSettings settings)
Constructs an instance of OsConfigServiceClient, using the given settings.
|
protected |
OsConfigServiceClient(OsConfigServiceStub stub) |
protected OsConfigServiceClient(OsConfigServiceSettings settings) throws IOException
IOExceptionprotected OsConfigServiceClient(OsConfigServiceStub stub)
public static final OsConfigServiceClient create() throws IOException
IOExceptionpublic static final OsConfigServiceClient create(OsConfigServiceSettings settings) throws IOException
IOExceptionpublic static final OsConfigServiceClient create(OsConfigServiceStub stub)
public final OsConfigServiceSettings getSettings()
public OsConfigServiceStub getStub()
public final PatchJobs.PatchJob executePatchJob(PatchJobs.ExecutePatchJobRequest request)
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 (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);
}
request - The request object containing all of the parameters for the API call.com.google.api.gax.rpc.ApiException - if the remote call failspublic final com.google.api.gax.rpc.UnaryCallable<PatchJobs.ExecutePatchJobRequest,PatchJobs.PatchJob> executePatchJobCallable()
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 (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<PatchJobs.PatchJob> future =
osConfigServiceClient.executePatchJobCallable().futureCall(request);
// Do something.
PatchJobs.PatchJob response = future.get();
}
public final PatchJobs.PatchJob getPatchJob(PatchJobs.GetPatchJobRequest request)
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 (OsConfigServiceClient osConfigServiceClient = OsConfigServiceClient.create()) {
PatchJobs.GetPatchJobRequest request =
PatchJobs.GetPatchJobRequest.newBuilder().setName("name3373707").build();
PatchJobs.PatchJob response = osConfigServiceClient.getPatchJob(request);
}
request - The request object containing all of the parameters for the API call.com.google.api.gax.rpc.ApiException - if the remote call failspublic final com.google.api.gax.rpc.UnaryCallable<PatchJobs.GetPatchJobRequest,PatchJobs.PatchJob> getPatchJobCallable()
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 (OsConfigServiceClient osConfigServiceClient = OsConfigServiceClient.create()) {
PatchJobs.GetPatchJobRequest request =
PatchJobs.GetPatchJobRequest.newBuilder().setName("name3373707").build();
ApiFuture<PatchJobs.PatchJob> future =
osConfigServiceClient.getPatchJobCallable().futureCall(request);
// Do something.
PatchJobs.PatchJob response = future.get();
}
public final PatchJobs.PatchJob cancelPatchJob(PatchJobs.CancelPatchJobRequest request)
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 (OsConfigServiceClient osConfigServiceClient = OsConfigServiceClient.create()) {
PatchJobs.CancelPatchJobRequest request =
PatchJobs.CancelPatchJobRequest.newBuilder().setName("name3373707").build();
PatchJobs.PatchJob response = osConfigServiceClient.cancelPatchJob(request);
}
request - The request object containing all of the parameters for the API call.com.google.api.gax.rpc.ApiException - if the remote call failspublic final com.google.api.gax.rpc.UnaryCallable<PatchJobs.CancelPatchJobRequest,PatchJobs.PatchJob> cancelPatchJobCallable()
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 (OsConfigServiceClient osConfigServiceClient = OsConfigServiceClient.create()) {
PatchJobs.CancelPatchJobRequest request =
PatchJobs.CancelPatchJobRequest.newBuilder().setName("name3373707").build();
ApiFuture<PatchJobs.PatchJob> future =
osConfigServiceClient.cancelPatchJobCallable().futureCall(request);
// Do something.
PatchJobs.PatchJob response = future.get();
}
public final OsConfigServiceClient.ListPatchJobsPagedResponse listPatchJobs(PatchJobs.ListPatchJobsRequest request)
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 (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);
}
}
request - The request object containing all of the parameters for the API call.com.google.api.gax.rpc.ApiException - if the remote call failspublic final com.google.api.gax.rpc.UnaryCallable<PatchJobs.ListPatchJobsRequest,OsConfigServiceClient.ListPatchJobsPagedResponse> listPatchJobsPagedCallable()
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 (OsConfigServiceClient osConfigServiceClient = OsConfigServiceClient.create()) {
PatchJobs.ListPatchJobsRequest request =
PatchJobs.ListPatchJobsRequest.newBuilder()
.setParent("parent-995424086")
.setPageSize(883849137)
.setPageToken("pageToken873572522")
.setFilter("filter-1274492040")
.build();
ApiFuture<PatchJobs.PatchJob> future =
osConfigServiceClient.listPatchJobsPagedCallable().futureCall(request);
// Do something.
for (PatchJobs.PatchJob element : future.get().iterateAll()) {
// doThingsWith(element);
}
}
public final com.google.api.gax.rpc.UnaryCallable<PatchJobs.ListPatchJobsRequest,PatchJobs.ListPatchJobsResponse> listPatchJobsCallable()
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 (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.getPatchJobsList()) {
// doThingsWith(element);
}
String nextPageToken = response.getNextPageToken();
if (!Strings.isNullOrEmpty(nextPageToken)) {
request = request.toBuilder().setPageToken(nextPageToken).build();
} else {
break;
}
}
}
public final OsConfigServiceClient.ListPatchJobInstanceDetailsPagedResponse listPatchJobInstanceDetails(String parent)
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 (OsConfigServiceClient osConfigServiceClient = OsConfigServiceClient.create()) {
String parent = "parent-995424086";
for (PatchJobs.PatchJobInstanceDetails element :
osConfigServiceClient.listPatchJobInstanceDetails(parent).iterateAll()) {
// doThingsWith(element);
}
}
parent - Required. The parent for the instances are in the form of
`projects/*/patchJobs/*`.com.google.api.gax.rpc.ApiException - if the remote call failspublic final OsConfigServiceClient.ListPatchJobInstanceDetailsPagedResponse listPatchJobInstanceDetails(PatchJobs.ListPatchJobInstanceDetailsRequest request)
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 (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);
}
}
request - The request object containing all of the parameters for the API call.com.google.api.gax.rpc.ApiException - if the remote call failspublic final com.google.api.gax.rpc.UnaryCallable<PatchJobs.ListPatchJobInstanceDetailsRequest,OsConfigServiceClient.ListPatchJobInstanceDetailsPagedResponse> listPatchJobInstanceDetailsPagedCallable()
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 (OsConfigServiceClient osConfigServiceClient = OsConfigServiceClient.create()) {
PatchJobs.ListPatchJobInstanceDetailsRequest request =
PatchJobs.ListPatchJobInstanceDetailsRequest.newBuilder()
.setParent("parent-995424086")
.setPageSize(883849137)
.setPageToken("pageToken873572522")
.setFilter("filter-1274492040")
.build();
ApiFuture<PatchJobs.PatchJobInstanceDetails> future =
osConfigServiceClient.listPatchJobInstanceDetailsPagedCallable().futureCall(request);
// Do something.
for (PatchJobs.PatchJobInstanceDetails element : future.get().iterateAll()) {
// doThingsWith(element);
}
}
public final com.google.api.gax.rpc.UnaryCallable<PatchJobs.ListPatchJobInstanceDetailsRequest,PatchJobs.ListPatchJobInstanceDetailsResponse> listPatchJobInstanceDetailsCallable()
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 (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.getPatchJobInstanceDetailsList()) {
// doThingsWith(element);
}
String nextPageToken = response.getNextPageToken();
if (!Strings.isNullOrEmpty(nextPageToken)) {
request = request.toBuilder().setPageToken(nextPageToken).build();
} else {
break;
}
}
}
public final PatchDeployments.PatchDeployment createPatchDeployment(PatchDeployments.CreatePatchDeploymentRequest request)
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 (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);
}
request - The request object containing all of the parameters for the API call.com.google.api.gax.rpc.ApiException - if the remote call failspublic final com.google.api.gax.rpc.UnaryCallable<PatchDeployments.CreatePatchDeploymentRequest,PatchDeployments.PatchDeployment> createPatchDeploymentCallable()
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 (OsConfigServiceClient osConfigServiceClient = OsConfigServiceClient.create()) {
PatchDeployments.CreatePatchDeploymentRequest request =
PatchDeployments.CreatePatchDeploymentRequest.newBuilder()
.setParent("parent-995424086")
.setPatchDeploymentId("patchDeploymentId-1180405976")
.setPatchDeployment(PatchDeployments.PatchDeployment.newBuilder().build())
.build();
ApiFuture<PatchDeployments.PatchDeployment> future =
osConfigServiceClient.createPatchDeploymentCallable().futureCall(request);
// Do something.
PatchDeployments.PatchDeployment response = future.get();
}
public final PatchDeployments.PatchDeployment getPatchDeployment(PatchDeployments.GetPatchDeploymentRequest request)
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 (OsConfigServiceClient osConfigServiceClient = OsConfigServiceClient.create()) {
PatchDeployments.GetPatchDeploymentRequest request =
PatchDeployments.GetPatchDeploymentRequest.newBuilder().setName("name3373707").build();
PatchDeployments.PatchDeployment response = osConfigServiceClient.getPatchDeployment(request);
}
request - The request object containing all of the parameters for the API call.com.google.api.gax.rpc.ApiException - if the remote call failspublic final com.google.api.gax.rpc.UnaryCallable<PatchDeployments.GetPatchDeploymentRequest,PatchDeployments.PatchDeployment> getPatchDeploymentCallable()
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 (OsConfigServiceClient osConfigServiceClient = OsConfigServiceClient.create()) {
PatchDeployments.GetPatchDeploymentRequest request =
PatchDeployments.GetPatchDeploymentRequest.newBuilder().setName("name3373707").build();
ApiFuture<PatchDeployments.PatchDeployment> future =
osConfigServiceClient.getPatchDeploymentCallable().futureCall(request);
// Do something.
PatchDeployments.PatchDeployment response = future.get();
}
public final OsConfigServiceClient.ListPatchDeploymentsPagedResponse listPatchDeployments(PatchDeployments.ListPatchDeploymentsRequest request)
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 (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);
}
}
request - The request object containing all of the parameters for the API call.com.google.api.gax.rpc.ApiException - if the remote call failspublic final com.google.api.gax.rpc.UnaryCallable<PatchDeployments.ListPatchDeploymentsRequest,OsConfigServiceClient.ListPatchDeploymentsPagedResponse> listPatchDeploymentsPagedCallable()
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 (OsConfigServiceClient osConfigServiceClient = OsConfigServiceClient.create()) {
PatchDeployments.ListPatchDeploymentsRequest request =
PatchDeployments.ListPatchDeploymentsRequest.newBuilder()
.setParent("parent-995424086")
.setPageSize(883849137)
.setPageToken("pageToken873572522")
.build();
ApiFuture<PatchDeployments.PatchDeployment> future =
osConfigServiceClient.listPatchDeploymentsPagedCallable().futureCall(request);
// Do something.
for (PatchDeployments.PatchDeployment element : future.get().iterateAll()) {
// doThingsWith(element);
}
}
public final com.google.api.gax.rpc.UnaryCallable<PatchDeployments.ListPatchDeploymentsRequest,PatchDeployments.ListPatchDeploymentsResponse> listPatchDeploymentsCallable()
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 (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.getPatchDeploymentsList()) {
// doThingsWith(element);
}
String nextPageToken = response.getNextPageToken();
if (!Strings.isNullOrEmpty(nextPageToken)) {
request = request.toBuilder().setPageToken(nextPageToken).build();
} else {
break;
}
}
}
public final void deletePatchDeployment(PatchDeployments.DeletePatchDeploymentRequest request)
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 (OsConfigServiceClient osConfigServiceClient = OsConfigServiceClient.create()) {
PatchDeployments.DeletePatchDeploymentRequest request =
PatchDeployments.DeletePatchDeploymentRequest.newBuilder().setName("name3373707").build();
osConfigServiceClient.deletePatchDeployment(request);
}
request - The request object containing all of the parameters for the API call.com.google.api.gax.rpc.ApiException - if the remote call failspublic final com.google.api.gax.rpc.UnaryCallable<PatchDeployments.DeletePatchDeploymentRequest,com.google.protobuf.Empty> deletePatchDeploymentCallable()
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 (OsConfigServiceClient osConfigServiceClient = OsConfigServiceClient.create()) {
PatchDeployments.DeletePatchDeploymentRequest request =
PatchDeployments.DeletePatchDeploymentRequest.newBuilder().setName("name3373707").build();
ApiFuture<Empty> future =
osConfigServiceClient.deletePatchDeploymentCallable().futureCall(request);
// Do something.
future.get();
}
public final PatchDeployments.PatchDeployment updatePatchDeployment(PatchDeployments.PatchDeployment patchDeployment, com.google.protobuf.FieldMask updateMask)
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 (OsConfigServiceClient osConfigServiceClient = OsConfigServiceClient.create()) {
PatchDeployments.PatchDeployment patchDeployment =
PatchDeployments.PatchDeployment.newBuilder().build();
FieldMask updateMask = FieldMask.newBuilder().build();
PatchDeployments.PatchDeployment response =
osConfigServiceClient.updatePatchDeployment(patchDeployment, updateMask);
}
patchDeployment - Required. The patch deployment to Update.updateMask - Optional. Field mask that controls which fields of the patch deployment
should be updated.com.google.api.gax.rpc.ApiException - if the remote call failspublic final PatchDeployments.PatchDeployment updatePatchDeployment(PatchDeployments.UpdatePatchDeploymentRequest request)
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 (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);
}
request - The request object containing all of the parameters for the API call.com.google.api.gax.rpc.ApiException - if the remote call failspublic final com.google.api.gax.rpc.UnaryCallable<PatchDeployments.UpdatePatchDeploymentRequest,PatchDeployments.PatchDeployment> updatePatchDeploymentCallable()
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 (OsConfigServiceClient osConfigServiceClient = OsConfigServiceClient.create()) {
PatchDeployments.UpdatePatchDeploymentRequest request =
PatchDeployments.UpdatePatchDeploymentRequest.newBuilder()
.setPatchDeployment(PatchDeployments.PatchDeployment.newBuilder().build())
.setUpdateMask(FieldMask.newBuilder().build())
.build();
ApiFuture<PatchDeployments.PatchDeployment> future =
osConfigServiceClient.updatePatchDeploymentCallable().futureCall(request);
// Do something.
PatchDeployments.PatchDeployment response = future.get();
}
public final PatchDeployments.PatchDeployment pausePatchDeployment(PatchDeploymentName name)
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 (OsConfigServiceClient osConfigServiceClient = OsConfigServiceClient.create()) {
PatchDeploymentName name = PatchDeploymentName.of("[PROJECT]", "[PATCH_DEPLOYMENT]");
PatchDeployments.PatchDeployment response = osConfigServiceClient.pausePatchDeployment(name);
}
name - Required. The resource name of the patch deployment in the form
`projects/*/patchDeployments/*`.com.google.api.gax.rpc.ApiException - if the remote call failspublic final PatchDeployments.PatchDeployment pausePatchDeployment(String name)
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 (OsConfigServiceClient osConfigServiceClient = OsConfigServiceClient.create()) {
String name = PatchDeploymentName.of("[PROJECT]", "[PATCH_DEPLOYMENT]").toString();
PatchDeployments.PatchDeployment response = osConfigServiceClient.pausePatchDeployment(name);
}
name - Required. The resource name of the patch deployment in the form
`projects/*/patchDeployments/*`.com.google.api.gax.rpc.ApiException - if the remote call failspublic final PatchDeployments.PatchDeployment pausePatchDeployment(PatchDeployments.PausePatchDeploymentRequest request)
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 (OsConfigServiceClient osConfigServiceClient = OsConfigServiceClient.create()) {
PatchDeployments.PausePatchDeploymentRequest request =
PatchDeployments.PausePatchDeploymentRequest.newBuilder()
.setName(PatchDeploymentName.of("[PROJECT]", "[PATCH_DEPLOYMENT]").toString())
.build();
PatchDeployments.PatchDeployment response =
osConfigServiceClient.pausePatchDeployment(request);
}
request - The request object containing all of the parameters for the API call.com.google.api.gax.rpc.ApiException - if the remote call failspublic final com.google.api.gax.rpc.UnaryCallable<PatchDeployments.PausePatchDeploymentRequest,PatchDeployments.PatchDeployment> pausePatchDeploymentCallable()
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 (OsConfigServiceClient osConfigServiceClient = OsConfigServiceClient.create()) {
PatchDeployments.PausePatchDeploymentRequest request =
PatchDeployments.PausePatchDeploymentRequest.newBuilder()
.setName(PatchDeploymentName.of("[PROJECT]", "[PATCH_DEPLOYMENT]").toString())
.build();
ApiFuture<PatchDeployments.PatchDeployment> future =
osConfigServiceClient.pausePatchDeploymentCallable().futureCall(request);
// Do something.
PatchDeployments.PatchDeployment response = future.get();
}
public final PatchDeployments.PatchDeployment resumePatchDeployment(PatchDeploymentName name)
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 (OsConfigServiceClient osConfigServiceClient = OsConfigServiceClient.create()) {
PatchDeploymentName name = PatchDeploymentName.of("[PROJECT]", "[PATCH_DEPLOYMENT]");
PatchDeployments.PatchDeployment response = osConfigServiceClient.resumePatchDeployment(name);
}
name - Required. The resource name of the patch deployment in the form
`projects/*/patchDeployments/*`.com.google.api.gax.rpc.ApiException - if the remote call failspublic final PatchDeployments.PatchDeployment resumePatchDeployment(String name)
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 (OsConfigServiceClient osConfigServiceClient = OsConfigServiceClient.create()) {
String name = PatchDeploymentName.of("[PROJECT]", "[PATCH_DEPLOYMENT]").toString();
PatchDeployments.PatchDeployment response = osConfigServiceClient.resumePatchDeployment(name);
}
name - Required. The resource name of the patch deployment in the form
`projects/*/patchDeployments/*`.com.google.api.gax.rpc.ApiException - if the remote call failspublic final PatchDeployments.PatchDeployment resumePatchDeployment(PatchDeployments.ResumePatchDeploymentRequest request)
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 (OsConfigServiceClient osConfigServiceClient = OsConfigServiceClient.create()) {
PatchDeployments.ResumePatchDeploymentRequest request =
PatchDeployments.ResumePatchDeploymentRequest.newBuilder()
.setName(PatchDeploymentName.of("[PROJECT]", "[PATCH_DEPLOYMENT]").toString())
.build();
PatchDeployments.PatchDeployment response =
osConfigServiceClient.resumePatchDeployment(request);
}
request - The request object containing all of the parameters for the API call.com.google.api.gax.rpc.ApiException - if the remote call failspublic final com.google.api.gax.rpc.UnaryCallable<PatchDeployments.ResumePatchDeploymentRequest,PatchDeployments.PatchDeployment> resumePatchDeploymentCallable()
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 (OsConfigServiceClient osConfigServiceClient = OsConfigServiceClient.create()) {
PatchDeployments.ResumePatchDeploymentRequest request =
PatchDeployments.ResumePatchDeploymentRequest.newBuilder()
.setName(PatchDeploymentName.of("[PROJECT]", "[PATCH_DEPLOYMENT]").toString())
.build();
ApiFuture<PatchDeployments.PatchDeployment> future =
osConfigServiceClient.resumePatchDeploymentCallable().futureCall(request);
// Do something.
PatchDeployments.PatchDeployment response = future.get();
}
public final GuestPolicies.GuestPolicy createGuestPolicy(ProjectName parent, GuestPolicies.GuestPolicy guestPolicy)
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 (OsConfigServiceClient osConfigServiceClient = OsConfigServiceClient.create()) {
ProjectName parent = ProjectName.of("[PROJECT]");
GuestPolicies.GuestPolicy guestPolicy = GuestPolicies.GuestPolicy.newBuilder().build();
GuestPolicies.GuestPolicy response =
osConfigServiceClient.createGuestPolicy(parent, guestPolicy);
}
parent - Required. The resource name of the parent using one of the following forms:
`projects/{project_number}`.guestPolicy - Required. The GuestPolicy to create.com.google.api.gax.rpc.ApiException - if the remote call failspublic final GuestPolicies.GuestPolicy createGuestPolicy(String parent, GuestPolicies.GuestPolicy guestPolicy)
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 (OsConfigServiceClient osConfigServiceClient = OsConfigServiceClient.create()) {
String parent = ProjectName.of("[PROJECT]").toString();
GuestPolicies.GuestPolicy guestPolicy = GuestPolicies.GuestPolicy.newBuilder().build();
GuestPolicies.GuestPolicy response =
osConfigServiceClient.createGuestPolicy(parent, guestPolicy);
}
parent - Required. The resource name of the parent using one of the following forms:
`projects/{project_number}`.guestPolicy - Required. The GuestPolicy to create.com.google.api.gax.rpc.ApiException - if the remote call failspublic final GuestPolicies.GuestPolicy createGuestPolicy(GuestPolicies.CreateGuestPolicyRequest request)
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 (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);
}
request - The request object containing all of the parameters for the API call.com.google.api.gax.rpc.ApiException - if the remote call failspublic final com.google.api.gax.rpc.UnaryCallable<GuestPolicies.CreateGuestPolicyRequest,GuestPolicies.GuestPolicy> createGuestPolicyCallable()
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 (OsConfigServiceClient osConfigServiceClient = OsConfigServiceClient.create()) {
GuestPolicies.CreateGuestPolicyRequest request =
GuestPolicies.CreateGuestPolicyRequest.newBuilder()
.setParent(ProjectName.of("[PROJECT]").toString())
.setGuestPolicyId("guestPolicyId1234592741")
.setGuestPolicy(GuestPolicies.GuestPolicy.newBuilder().build())
.build();
ApiFuture<GuestPolicies.GuestPolicy> future =
osConfigServiceClient.createGuestPolicyCallable().futureCall(request);
// Do something.
GuestPolicies.GuestPolicy response = future.get();
}
public final GuestPolicies.GuestPolicy getGuestPolicy(GuestPolicyName name)
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 (OsConfigServiceClient osConfigServiceClient = OsConfigServiceClient.create()) {
GuestPolicyName name = GuestPolicyName.of("[PROJECT]", "[GUEST_POLICY]");
GuestPolicies.GuestPolicy response = osConfigServiceClient.getGuestPolicy(name);
}
name - Required. The resource name of the guest policy using one of the following forms:
`projects/{project_number}/guestPolicies/{guest_policy_id}`.com.google.api.gax.rpc.ApiException - if the remote call failspublic final GuestPolicies.GuestPolicy getGuestPolicy(String name)
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 (OsConfigServiceClient osConfigServiceClient = OsConfigServiceClient.create()) {
String name = GuestPolicyName.of("[PROJECT]", "[GUEST_POLICY]").toString();
GuestPolicies.GuestPolicy response = osConfigServiceClient.getGuestPolicy(name);
}
name - Required. The resource name of the guest policy using one of the following forms:
`projects/{project_number}/guestPolicies/{guest_policy_id}`.com.google.api.gax.rpc.ApiException - if the remote call failspublic final GuestPolicies.GuestPolicy getGuestPolicy(GuestPolicies.GetGuestPolicyRequest request)
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 (OsConfigServiceClient osConfigServiceClient = OsConfigServiceClient.create()) {
GuestPolicies.GetGuestPolicyRequest request =
GuestPolicies.GetGuestPolicyRequest.newBuilder()
.setName(GuestPolicyName.of("[PROJECT]", "[GUEST_POLICY]").toString())
.build();
GuestPolicies.GuestPolicy response = osConfigServiceClient.getGuestPolicy(request);
}
request - The request object containing all of the parameters for the API call.com.google.api.gax.rpc.ApiException - if the remote call failspublic final com.google.api.gax.rpc.UnaryCallable<GuestPolicies.GetGuestPolicyRequest,GuestPolicies.GuestPolicy> getGuestPolicyCallable()
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 (OsConfigServiceClient osConfigServiceClient = OsConfigServiceClient.create()) {
GuestPolicies.GetGuestPolicyRequest request =
GuestPolicies.GetGuestPolicyRequest.newBuilder()
.setName(GuestPolicyName.of("[PROJECT]", "[GUEST_POLICY]").toString())
.build();
ApiFuture<GuestPolicies.GuestPolicy> future =
osConfigServiceClient.getGuestPolicyCallable().futureCall(request);
// Do something.
GuestPolicies.GuestPolicy response = future.get();
}
public final OsConfigServiceClient.ListGuestPoliciesPagedResponse listGuestPolicies(ProjectName parent)
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 (OsConfigServiceClient osConfigServiceClient = OsConfigServiceClient.create()) {
ProjectName parent = ProjectName.of("[PROJECT]");
for (GuestPolicies.GuestPolicy element :
osConfigServiceClient.listGuestPolicies(parent).iterateAll()) {
// doThingsWith(element);
}
}
parent - Required. The resource name of the parent using one of the following forms:
`projects/{project_number}`.com.google.api.gax.rpc.ApiException - if the remote call failspublic final OsConfigServiceClient.ListGuestPoliciesPagedResponse listGuestPolicies(String parent)
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 (OsConfigServiceClient osConfigServiceClient = OsConfigServiceClient.create()) {
String parent = ProjectName.of("[PROJECT]").toString();
for (GuestPolicies.GuestPolicy element :
osConfigServiceClient.listGuestPolicies(parent).iterateAll()) {
// doThingsWith(element);
}
}
parent - Required. The resource name of the parent using one of the following forms:
`projects/{project_number}`.com.google.api.gax.rpc.ApiException - if the remote call failspublic final OsConfigServiceClient.ListGuestPoliciesPagedResponse listGuestPolicies(GuestPolicies.ListGuestPoliciesRequest request)
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 (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);
}
}
request - The request object containing all of the parameters for the API call.com.google.api.gax.rpc.ApiException - if the remote call failspublic final com.google.api.gax.rpc.UnaryCallable<GuestPolicies.ListGuestPoliciesRequest,OsConfigServiceClient.ListGuestPoliciesPagedResponse> listGuestPoliciesPagedCallable()
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 (OsConfigServiceClient osConfigServiceClient = OsConfigServiceClient.create()) {
GuestPolicies.ListGuestPoliciesRequest request =
GuestPolicies.ListGuestPoliciesRequest.newBuilder()
.setParent(ProjectName.of("[PROJECT]").toString())
.setPageSize(883849137)
.setPageToken("pageToken873572522")
.build();
ApiFuture<GuestPolicies.GuestPolicy> future =
osConfigServiceClient.listGuestPoliciesPagedCallable().futureCall(request);
// Do something.
for (GuestPolicies.GuestPolicy element : future.get().iterateAll()) {
// doThingsWith(element);
}
}
public final com.google.api.gax.rpc.UnaryCallable<GuestPolicies.ListGuestPoliciesRequest,GuestPolicies.ListGuestPoliciesResponse> listGuestPoliciesCallable()
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 (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.getGuestPoliciesList()) {
// doThingsWith(element);
}
String nextPageToken = response.getNextPageToken();
if (!Strings.isNullOrEmpty(nextPageToken)) {
request = request.toBuilder().setPageToken(nextPageToken).build();
} else {
break;
}
}
}
public final GuestPolicies.GuestPolicy updateGuestPolicy(GuestPolicies.GuestPolicy guestPolicy, com.google.protobuf.FieldMask updateMask)
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 (OsConfigServiceClient osConfigServiceClient = OsConfigServiceClient.create()) {
GuestPolicies.GuestPolicy guestPolicy = GuestPolicies.GuestPolicy.newBuilder().build();
FieldMask updateMask = FieldMask.newBuilder().build();
GuestPolicies.GuestPolicy response =
osConfigServiceClient.updateGuestPolicy(guestPolicy, updateMask);
}
guestPolicy - Required. The updated GuestPolicy.updateMask - Field mask that controls which fields of the guest policy should be updated.com.google.api.gax.rpc.ApiException - if the remote call failspublic final GuestPolicies.GuestPolicy updateGuestPolicy(GuestPolicies.UpdateGuestPolicyRequest request)
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 (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);
}
request - The request object containing all of the parameters for the API call.com.google.api.gax.rpc.ApiException - if the remote call failspublic final com.google.api.gax.rpc.UnaryCallable<GuestPolicies.UpdateGuestPolicyRequest,GuestPolicies.GuestPolicy> updateGuestPolicyCallable()
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 (OsConfigServiceClient osConfigServiceClient = OsConfigServiceClient.create()) {
GuestPolicies.UpdateGuestPolicyRequest request =
GuestPolicies.UpdateGuestPolicyRequest.newBuilder()
.setGuestPolicy(GuestPolicies.GuestPolicy.newBuilder().build())
.setUpdateMask(FieldMask.newBuilder().build())
.build();
ApiFuture<GuestPolicies.GuestPolicy> future =
osConfigServiceClient.updateGuestPolicyCallable().futureCall(request);
// Do something.
GuestPolicies.GuestPolicy response = future.get();
}
public final void deleteGuestPolicy(GuestPolicyName name)
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 (OsConfigServiceClient osConfigServiceClient = OsConfigServiceClient.create()) {
GuestPolicyName name = GuestPolicyName.of("[PROJECT]", "[GUEST_POLICY]");
osConfigServiceClient.deleteGuestPolicy(name);
}
name - Required. The resource name of the guest policy using one of the following forms:
`projects/{project_number}/guestPolicies/{guest_policy_id}`.com.google.api.gax.rpc.ApiException - if the remote call failspublic final void deleteGuestPolicy(String name)
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 (OsConfigServiceClient osConfigServiceClient = OsConfigServiceClient.create()) {
String name = GuestPolicyName.of("[PROJECT]", "[GUEST_POLICY]").toString();
osConfigServiceClient.deleteGuestPolicy(name);
}
name - Required. The resource name of the guest policy using one of the following forms:
`projects/{project_number}/guestPolicies/{guest_policy_id}`.com.google.api.gax.rpc.ApiException - if the remote call failspublic final void deleteGuestPolicy(GuestPolicies.DeleteGuestPolicyRequest request)
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 (OsConfigServiceClient osConfigServiceClient = OsConfigServiceClient.create()) {
GuestPolicies.DeleteGuestPolicyRequest request =
GuestPolicies.DeleteGuestPolicyRequest.newBuilder()
.setName(GuestPolicyName.of("[PROJECT]", "[GUEST_POLICY]").toString())
.build();
osConfigServiceClient.deleteGuestPolicy(request);
}
request - The request object containing all of the parameters for the API call.com.google.api.gax.rpc.ApiException - if the remote call failspublic final com.google.api.gax.rpc.UnaryCallable<GuestPolicies.DeleteGuestPolicyRequest,com.google.protobuf.Empty> deleteGuestPolicyCallable()
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 (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();
}
public final GuestPolicies.EffectiveGuestPolicy lookupEffectiveGuestPolicy(GuestPolicies.LookupEffectiveGuestPolicyRequest request)
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 (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);
}
request - The request object containing all of the parameters for the API call.com.google.api.gax.rpc.ApiException - if the remote call failspublic final com.google.api.gax.rpc.UnaryCallable<GuestPolicies.LookupEffectiveGuestPolicyRequest,GuestPolicies.EffectiveGuestPolicy> lookupEffectiveGuestPolicyCallable()
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 (OsConfigServiceClient osConfigServiceClient = OsConfigServiceClient.create()) {
GuestPolicies.LookupEffectiveGuestPolicyRequest request =
GuestPolicies.LookupEffectiveGuestPolicyRequest.newBuilder()
.setInstance("instance555127957")
.setOsShortName("osShortName1253394339")
.setOsVersion("osVersion1812004436")
.setOsArchitecture("osArchitecture1339954519")
.build();
ApiFuture<GuestPolicies.EffectiveGuestPolicy> future =
osConfigServiceClient.lookupEffectiveGuestPolicyCallable().futureCall(request);
// Do something.
GuestPolicies.EffectiveGuestPolicy response = future.get();
}
public final void close()
close in interface AutoCloseablepublic void shutdown()
shutdown in interface com.google.api.gax.core.BackgroundResourcepublic boolean isShutdown()
isShutdown in interface com.google.api.gax.core.BackgroundResourcepublic boolean isTerminated()
isTerminated in interface com.google.api.gax.core.BackgroundResourcepublic void shutdownNow()
shutdownNow in interface com.google.api.gax.core.BackgroundResourcepublic boolean awaitTermination(long duration,
TimeUnit unit)
throws InterruptedException
awaitTermination in interface com.google.api.gax.core.BackgroundResourceInterruptedExceptionCopyright © 2024 Google LLC. All rights reserved.