Class AssuredWorkloadsServiceClient (2.41.0)

Version latest

• 2.41.0 (latest)
• 2.40.0
• 2.39.0
• 2.37.0
• 2.36.0
• 2.35.0
• 2.34.0
• 2.33.0
• 2.32.0
• 2.31.0
• 2.30.0
• 2.29.0
• 2.28.0
• 2.27.0
• 2.24.0
• 2.23.0
• 2.22.0
• 2.21.0
• 2.20.0
• 2.19.0
• 2.18.0
• 2.17.0
• 2.16.0
• 2.15.0
• 2.14.0
• 2.13.0
• 2.12.0
• 2.11.0
• 2.10.0
• 2.9.0
• 2.8.0
• 2.7.0
• 2.6.0
• 2.5.0
• 2.4.0
• 2.3.0
• 2.1.0
• 2.0.0
• 1.1.0
• 1.0.4
• 0.9.0
• 0.8.2

Beta

This library is covered by the Pre-GA Offerings Terms of the Terms of Service. Pre-GA libraries might have limited support, and changes to pre-GA libraries might not be compatible with other pre-GA versions. For more information, see the launch stage descriptions.

GitHub Repository

Product Reference

REST Documentation

Service Description: Service to manage AssuredWorkloads.

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 (AssuredWorkloadsServiceClient assuredWorkloadsServiceClient =
     AssuredWorkloadsServiceClient.create()) {
   Workload workload = Workload.newBuilder().build();
   FieldMask updateMask = FieldMask.newBuilder().build();
   Workload response = assuredWorkloadsServiceClient.updateWorkload(workload, updateMask);
 }
 

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

Methods

Method	Description	Method Variants
CreateWorkload	Creates Assured Workload.	Request object method variants only take one parameter, a request object, which must be constructed before the call. createWorkloadAsync(CreateWorkloadRequest request) Methods that return long-running operations have "Async" method variants that return OperationFuture, which is used to track polling of the service. createWorkloadAsync(LocationName parent, Workload workload) createWorkloadAsync(String parent, Workload workload) Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service. createWorkloadOperationCallable() createWorkloadCallable()
UpdateWorkload	Updates an existing workload. Currently allows updating of workload display_name and labels. For force updates don't set etag field in the Workload. Only one update operation per workload can be in progress.	Request object method variants only take one parameter, a request object, which must be constructed before the call. updateWorkload(UpdateWorkloadRequest request) "Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method. updateWorkload(Workload workload, FieldMask updateMask) Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service. updateWorkloadCallable()
RestrictAllowedResources	Restrict the list of resources allowed in the Workload environment. The current list of allowed products can be found at https://cloud.google.com/assured-workloads/docs/supported-products In addition to assuredworkloads.workload.update permission, the user should also have orgpolicy.policy.set permission on the folder resource to use this functionality.	Request object method variants only take one parameter, a request object, which must be constructed before the call. restrictAllowedResources(RestrictAllowedResourcesRequest request) Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service. restrictAllowedResourcesCallable()
DeleteWorkload	Deletes the workload. Make sure that workload's direct children are already in a deleted state, otherwise the request will fail with a FAILED_PRECONDITION error. In addition to assuredworkloads.workload.delete permission, the user should also have orgpolicy.policy.set permission on the deleted folder to remove Assured Workloads OrgPolicies.	Request object method variants only take one parameter, a request object, which must be constructed before the call. deleteWorkload(DeleteWorkloadRequest request) "Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method. deleteWorkload(WorkloadName name) deleteWorkload(String name) Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service. deleteWorkloadCallable()
GetWorkload	Gets Assured Workload associated with a CRM Node	Request object method variants only take one parameter, a request object, which must be constructed before the call. getWorkload(GetWorkloadRequest request) "Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method. getWorkload(WorkloadName name) getWorkload(String name) Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service. getWorkloadCallable()
AnalyzeWorkloadMove	Analyze if the source Assured Workloads can be moved to the target Assured Workload	Request object method variants only take one parameter, a request object, which must be constructed before the call. analyzeWorkloadMove(AnalyzeWorkloadMoveRequest request) "Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method. analyzeWorkloadMove(String project, String target) Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service. analyzeWorkloadMoveCallable()
ListWorkloads	Lists Assured Workloads under a CRM Node.	Request object method variants only take one parameter, a request object, which must be constructed before the call. listWorkloads(ListWorkloadsRequest request) "Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method. listWorkloads(LocationName parent) listWorkloads(String parent) Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service. listWorkloadsPagedCallable() listWorkloadsCallable()

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 AssuredWorkloadsServiceSettings 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
 AssuredWorkloadsServiceSettings assuredWorkloadsServiceSettings =
     AssuredWorkloadsServiceSettings.newBuilder()
         .setCredentialsProvider(FixedCredentialsProvider.create(myCredentials))
         .build();
 AssuredWorkloadsServiceClient assuredWorkloadsServiceClient =
     AssuredWorkloadsServiceClient.create(assuredWorkloadsServiceSettings);
 

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
 AssuredWorkloadsServiceSettings assuredWorkloadsServiceSettings =
     AssuredWorkloadsServiceSettings.newBuilder().setEndpoint(myEndpoint).build();
 AssuredWorkloadsServiceClient assuredWorkloadsServiceClient =
     AssuredWorkloadsServiceClient.create(assuredWorkloadsServiceSettings);
 

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
 AssuredWorkloadsServiceSettings assuredWorkloadsServiceSettings =
     AssuredWorkloadsServiceSettings.newHttpJsonBuilder().build();
 AssuredWorkloadsServiceClient assuredWorkloadsServiceClient =
     AssuredWorkloadsServiceClient.create(assuredWorkloadsServiceSettings);
 

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

Inheritance

java.lang.Object > AssuredWorkloadsServiceClient

Static Methods

create()

public static final AssuredWorkloadsServiceClient create()

Constructs an instance of AssuredWorkloadsServiceClient with default settings.

Returns
Type	Description
AssuredWorkloadsServiceClient

Exceptions
Type	Description
IOException

create(AssuredWorkloadsServiceSettings settings)

public static final AssuredWorkloadsServiceClient create(AssuredWorkloadsServiceSettings settings)

Constructs an instance of AssuredWorkloadsServiceClient, 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	AssuredWorkloadsServiceSettings

Returns
Type	Description
AssuredWorkloadsServiceClient

Exceptions
Type	Description
IOException

create(AssuredWorkloadsServiceStub stub)

public static final AssuredWorkloadsServiceClient create(AssuredWorkloadsServiceStub stub)

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

Parameter
Name	Description
stub	AssuredWorkloadsServiceStub

Returns
Type	Description
AssuredWorkloadsServiceClient

Constructors

AssuredWorkloadsServiceClient(AssuredWorkloadsServiceSettings settings)

protected AssuredWorkloadsServiceClient(AssuredWorkloadsServiceSettings settings)

Constructs an instance of AssuredWorkloadsServiceClient, 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	AssuredWorkloadsServiceSettings

AssuredWorkloadsServiceClient(AssuredWorkloadsServiceStub stub)

protected AssuredWorkloadsServiceClient(AssuredWorkloadsServiceStub stub)

Parameter
Name	Description
stub	AssuredWorkloadsServiceStub

Methods

analyzeWorkloadMove(AnalyzeWorkloadMoveRequest request)

public final AnalyzeWorkloadMoveResponse analyzeWorkloadMove(AnalyzeWorkloadMoveRequest request)

Analyze if the source Assured Workloads can be moved to the target Assured Workload

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 (AssuredWorkloadsServiceClient assuredWorkloadsServiceClient =
     AssuredWorkloadsServiceClient.create()) {
   AnalyzeWorkloadMoveRequest request =
       AnalyzeWorkloadMoveRequest.newBuilder().setTarget("target-880905839").build();
   AnalyzeWorkloadMoveResponse response =
       assuredWorkloadsServiceClient.analyzeWorkloadMove(request);
 }
 

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

Returns
Type	Description
AnalyzeWorkloadMoveResponse

analyzeWorkloadMove(String project, String target)

public final AnalyzeWorkloadMoveResponse analyzeWorkloadMove(String project, String target)

Analyze if the source Assured Workloads can be moved to the target Assured Workload

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 (AssuredWorkloadsServiceClient assuredWorkloadsServiceClient =
     AssuredWorkloadsServiceClient.create()) {
   String project = "project-309310695";
   String target = "target-880905839";
   AnalyzeWorkloadMoveResponse response =
       assuredWorkloadsServiceClient.analyzeWorkloadMove(project, target);
 }
 

Parameters
Name	Description
project	String The source type is a project. Specify the project's relative resource name, formatted as either a project number or a project ID: "projects/{PROJECT_NUMBER}" or "projects/{PROJECT_ID}" For example: "projects/951040570662" when specifying a project number, or "projects/my-project-123" when specifying a project ID.
target	String Required. The resource ID of the folder-based destination workload. This workload is where the source project will hypothetically be moved to. Specify the workload's relative resource name, formatted as: "organizations/{ORGANIZATION_ID}/locations/{LOCATION_ID}/workloads/{WORKLOAD_ID}" For example: "organizations/123/locations/us-east1/workloads/assured-workload-2"

Returns
Type	Description
AnalyzeWorkloadMoveResponse

analyzeWorkloadMoveCallable()

public final UnaryCallable<AnalyzeWorkloadMoveRequest,AnalyzeWorkloadMoveResponse> analyzeWorkloadMoveCallable()

Analyze if the source Assured Workloads can be moved to the target Assured Workload

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 (AssuredWorkloadsServiceClient assuredWorkloadsServiceClient =
     AssuredWorkloadsServiceClient.create()) {
   AnalyzeWorkloadMoveRequest request =
       AnalyzeWorkloadMoveRequest.newBuilder().setTarget("target-880905839").build();
   ApiFuture<AnalyzeWorkloadMoveResponse> future =
       assuredWorkloadsServiceClient.analyzeWorkloadMoveCallable().futureCall(request);
   // Do something.
   AnalyzeWorkloadMoveResponse response = future.get();
 }
 

Returns
Type	Description
UnaryCallable<AnalyzeWorkloadMoveRequest,AnalyzeWorkloadMoveResponse>

awaitTermination(long duration, TimeUnit unit)

public boolean awaitTermination(long duration, TimeUnit unit)

Parameters
Name	Description
duration	long
unit	TimeUnit

Returns
Type	Description
boolean

Exceptions
Type	Description
InterruptedException

close()

public final void close()

createWorkloadAsync(CreateWorkloadRequest request)

public final OperationFuture<Workload,CreateWorkloadOperationMetadata> createWorkloadAsync(CreateWorkloadRequest request)

Creates Assured Workload.

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 (AssuredWorkloadsServiceClient assuredWorkloadsServiceClient =
     AssuredWorkloadsServiceClient.create()) {
   CreateWorkloadRequest request =
       CreateWorkloadRequest.newBuilder()
           .setParent(LocationName.of("[ORGANIZATION]", "[LOCATION]").toString())
           .setWorkload(Workload.newBuilder().build())
           .setExternalId("externalId-1699764666")
           .build();
   Workload response = assuredWorkloadsServiceClient.createWorkloadAsync(request).get();
 }
 

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

Returns
Type	Description
OperationFuture<Workload,CreateWorkloadOperationMetadata>

createWorkloadAsync(LocationName parent, Workload workload)

public final OperationFuture<Workload,CreateWorkloadOperationMetadata> createWorkloadAsync(LocationName parent, Workload workload)

Creates Assured Workload.

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 (AssuredWorkloadsServiceClient assuredWorkloadsServiceClient =
     AssuredWorkloadsServiceClient.create()) {
   LocationName parent = LocationName.of("[ORGANIZATION]", "[LOCATION]");
   Workload workload = Workload.newBuilder().build();
   Workload response = assuredWorkloadsServiceClient.createWorkloadAsync(parent, workload).get();
 }
 

Parameters
Name	Description
parent	LocationName Required. The resource name of the new Workload's parent. Must be of the form organizations/{org_id}/locations/{location_id}.
workload	Workload Required. Assured Workload to create

Returns
Type	Description
OperationFuture<Workload,CreateWorkloadOperationMetadata>

createWorkloadAsync(String parent, Workload workload)

public final OperationFuture<Workload,CreateWorkloadOperationMetadata> createWorkloadAsync(String parent, Workload workload)

Creates Assured Workload.

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 (AssuredWorkloadsServiceClient assuredWorkloadsServiceClient =
     AssuredWorkloadsServiceClient.create()) {
   String parent = LocationName.of("[ORGANIZATION]", "[LOCATION]").toString();
   Workload workload = Workload.newBuilder().build();
   Workload response = assuredWorkloadsServiceClient.createWorkloadAsync(parent, workload).get();
 }
 

Parameters
Name	Description
parent	String Required. The resource name of the new Workload's parent. Must be of the form organizations/{org_id}/locations/{location_id}.
workload	Workload Required. Assured Workload to create

Returns
Type	Description
OperationFuture<Workload,CreateWorkloadOperationMetadata>

createWorkloadCallable()

public final UnaryCallable<CreateWorkloadRequest,Operation> createWorkloadCallable()

Creates Assured Workload.

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 (AssuredWorkloadsServiceClient assuredWorkloadsServiceClient =
     AssuredWorkloadsServiceClient.create()) {
   CreateWorkloadRequest request =
       CreateWorkloadRequest.newBuilder()
           .setParent(LocationName.of("[ORGANIZATION]", "[LOCATION]").toString())
           .setWorkload(Workload.newBuilder().build())
           .setExternalId("externalId-1699764666")
           .build();
   ApiFuture<Operation> future =
       assuredWorkloadsServiceClient.createWorkloadCallable().futureCall(request);
   // Do something.
   Operation response = future.get();
 }
 

Returns
Type	Description
UnaryCallable<CreateWorkloadRequest,Operation>

createWorkloadOperationCallable()

public final OperationCallable<CreateWorkloadRequest,Workload,CreateWorkloadOperationMetadata> createWorkloadOperationCallable()

Creates Assured Workload.

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 (AssuredWorkloadsServiceClient assuredWorkloadsServiceClient =
     AssuredWorkloadsServiceClient.create()) {
   CreateWorkloadRequest request =
       CreateWorkloadRequest.newBuilder()
           .setParent(LocationName.of("[ORGANIZATION]", "[LOCATION]").toString())
           .setWorkload(Workload.newBuilder().build())
           .setExternalId("externalId-1699764666")
           .build();
   OperationFuture<Workload, CreateWorkloadOperationMetadata> future =
       assuredWorkloadsServiceClient.createWorkloadOperationCallable().futureCall(request);
   // Do something.
   Workload response = future.get();
 }
 

Returns
Type	Description
OperationCallable<CreateWorkloadRequest,Workload,CreateWorkloadOperationMetadata>

deleteWorkload(DeleteWorkloadRequest request)

public final void deleteWorkload(DeleteWorkloadRequest request)

Deletes the workload. Make sure that workload's direct children are already in a deleted state, otherwise the request will fail with a FAILED_PRECONDITION error. In addition to assuredworkloads.workload.delete permission, the user should also have orgpolicy.policy.set permission on the deleted folder to remove Assured Workloads OrgPolicies.

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 (AssuredWorkloadsServiceClient assuredWorkloadsServiceClient =
     AssuredWorkloadsServiceClient.create()) {
   DeleteWorkloadRequest request =
       DeleteWorkloadRequest.newBuilder()
           .setName(WorkloadName.of("[ORGANIZATION]", "[LOCATION]", "[WORKLOAD]").toString())
           .setEtag("etag3123477")
           .build();
   assuredWorkloadsServiceClient.deleteWorkload(request);
 }
 

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

deleteWorkload(WorkloadName name)

public final void deleteWorkload(WorkloadName name)

Deletes the workload. Make sure that workload's direct children are already in a deleted state, otherwise the request will fail with a FAILED_PRECONDITION error. In addition to assuredworkloads.workload.delete permission, the user should also have orgpolicy.policy.set permission on the deleted folder to remove Assured Workloads OrgPolicies.

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 (AssuredWorkloadsServiceClient assuredWorkloadsServiceClient =
     AssuredWorkloadsServiceClient.create()) {
   WorkloadName name = WorkloadName.of("[ORGANIZATION]", "[LOCATION]", "[WORKLOAD]");
   assuredWorkloadsServiceClient.deleteWorkload(name);
 }
 

Parameter
Name	Description
name	WorkloadName Required. The name field is used to identify the workload. Format: organizations/{org_id}/locations/{location_id}/workloads/{workload_id}

deleteWorkload(String name)

public final void deleteWorkload(String name)

Deletes the workload. Make sure that workload's direct children are already in a deleted state, otherwise the request will fail with a FAILED_PRECONDITION error. In addition to assuredworkloads.workload.delete permission, the user should also have orgpolicy.policy.set permission on the deleted folder to remove Assured Workloads OrgPolicies.

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 (AssuredWorkloadsServiceClient assuredWorkloadsServiceClient =
     AssuredWorkloadsServiceClient.create()) {
   String name = WorkloadName.of("[ORGANIZATION]", "[LOCATION]", "[WORKLOAD]").toString();
   assuredWorkloadsServiceClient.deleteWorkload(name);
 }
 

Parameter
Name	Description
name	String Required. The name field is used to identify the workload. Format: organizations/{org_id}/locations/{location_id}/workloads/{workload_id}

deleteWorkloadCallable()

public final UnaryCallable<DeleteWorkloadRequest,Empty> deleteWorkloadCallable()

Deletes the workload. Make sure that workload's direct children are already in a deleted state, otherwise the request will fail with a FAILED_PRECONDITION error. In addition to assuredworkloads.workload.delete permission, the user should also have orgpolicy.policy.set permission on the deleted folder to remove Assured Workloads OrgPolicies.

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 (AssuredWorkloadsServiceClient assuredWorkloadsServiceClient =
     AssuredWorkloadsServiceClient.create()) {
   DeleteWorkloadRequest request =
       DeleteWorkloadRequest.newBuilder()
           .setName(WorkloadName.of("[ORGANIZATION]", "[LOCATION]", "[WORKLOAD]").toString())
           .setEtag("etag3123477")
           .build();
   ApiFuture<Empty> future =
       assuredWorkloadsServiceClient.deleteWorkloadCallable().futureCall(request);
   // Do something.
   future.get();
 }
 

Returns
Type	Description
UnaryCallable<DeleteWorkloadRequest,Empty>

getHttpJsonOperationsClient()

public final OperationsClient getHttpJsonOperationsClient()

Beta

This feature is covered by the Pre-GA Offerings Terms of the Terms of Service. Pre-GA libraries might have limited support, and changes to pre-GA libraries might not be compatible with other pre-GA versions. For more information, see the launch stage descriptions.

Returns the OperationsClient that can be used to query the status of a long-running operation returned by another API method call.

Returns
Type	Description
OperationsClient

getOperationsClient()

public final OperationsClient getOperationsClient()

Returns the OperationsClient that can be used to query the status of a long-running operation returned by another API method call.

Returns
Type	Description
OperationsClient

getSettings()

public final AssuredWorkloadsServiceSettings getSettings()

Returns
Type	Description
AssuredWorkloadsServiceSettings

getStub()

public AssuredWorkloadsServiceStub getStub()

Returns
Type	Description
AssuredWorkloadsServiceStub

getWorkload(GetWorkloadRequest request)

public final Workload getWorkload(GetWorkloadRequest request)

Gets Assured Workload associated with a CRM Node

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 (AssuredWorkloadsServiceClient assuredWorkloadsServiceClient =
     AssuredWorkloadsServiceClient.create()) {
   GetWorkloadRequest request =
       GetWorkloadRequest.newBuilder()
           .setName(WorkloadName.of("[ORGANIZATION]", "[LOCATION]", "[WORKLOAD]").toString())
           .build();
   Workload response = assuredWorkloadsServiceClient.getWorkload(request);
 }
 

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

Returns
Type	Description
Workload

getWorkload(WorkloadName name)

public final Workload getWorkload(WorkloadName name)

Gets Assured Workload associated with a CRM Node

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 (AssuredWorkloadsServiceClient assuredWorkloadsServiceClient =
     AssuredWorkloadsServiceClient.create()) {
   WorkloadName name = WorkloadName.of("[ORGANIZATION]", "[LOCATION]", "[WORKLOAD]");
   Workload response = assuredWorkloadsServiceClient.getWorkload(name);
 }
 

Parameter
Name	Description
name	WorkloadName Required. The resource name of the Workload to fetch. This is the workloads's relative path in the API, formatted as "organizations/{organization_id}/locations/{location_id}/workloads/{workload_id}". For example, "organizations/123/locations/us-east1/workloads/assured-workload-1".

Returns
Type	Description
Workload

getWorkload(String name)

public final Workload getWorkload(String name)

Gets Assured Workload associated with a CRM Node

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 (AssuredWorkloadsServiceClient assuredWorkloadsServiceClient =
     AssuredWorkloadsServiceClient.create()) {
   String name = WorkloadName.of("[ORGANIZATION]", "[LOCATION]", "[WORKLOAD]").toString();
   Workload response = assuredWorkloadsServiceClient.getWorkload(name);
 }
 

Parameter
Name	Description
name	String Required. The resource name of the Workload to fetch. This is the workloads's relative path in the API, formatted as "organizations/{organization_id}/locations/{location_id}/workloads/{workload_id}". For example, "organizations/123/locations/us-east1/workloads/assured-workload-1".

Returns
Type	Description
Workload

getWorkloadCallable()

public final UnaryCallable<GetWorkloadRequest,Workload> getWorkloadCallable()

Gets Assured Workload associated with a CRM Node

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 (AssuredWorkloadsServiceClient assuredWorkloadsServiceClient =
     AssuredWorkloadsServiceClient.create()) {
   GetWorkloadRequest request =
       GetWorkloadRequest.newBuilder()
           .setName(WorkloadName.of("[ORGANIZATION]", "[LOCATION]", "[WORKLOAD]").toString())
           .build();
   ApiFuture<Workload> future =
       assuredWorkloadsServiceClient.getWorkloadCallable().futureCall(request);
   // Do something.
   Workload response = future.get();
 }
 

Returns
Type	Description
UnaryCallable<GetWorkloadRequest,Workload>

isShutdown()

public boolean isShutdown()

Returns
Type	Description
boolean

isTerminated()

public boolean isTerminated()

Returns
Type	Description
boolean

listWorkloads(ListWorkloadsRequest request)

public final AssuredWorkloadsServiceClient.ListWorkloadsPagedResponse listWorkloads(ListWorkloadsRequest request)

Lists Assured Workloads under a CRM Node.

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 (AssuredWorkloadsServiceClient assuredWorkloadsServiceClient =
     AssuredWorkloadsServiceClient.create()) {
   ListWorkloadsRequest request =
       ListWorkloadsRequest.newBuilder()
           .setParent(LocationName.of("[ORGANIZATION]", "[LOCATION]").toString())
           .setPageSize(883849137)
           .setPageToken("pageToken873572522")
           .setFilter("filter-1274492040")
           .build();
   for (Workload element : assuredWorkloadsServiceClient.listWorkloads(request).iterateAll()) {
     // doThingsWith(element);
   }
 }
 

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

Returns
Type	Description
AssuredWorkloadsServiceClient.ListWorkloadsPagedResponse

listWorkloads(LocationName parent)

public final AssuredWorkloadsServiceClient.ListWorkloadsPagedResponse listWorkloads(LocationName parent)

Lists Assured Workloads under a CRM Node.

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 (AssuredWorkloadsServiceClient assuredWorkloadsServiceClient =
     AssuredWorkloadsServiceClient.create()) {
   LocationName parent = LocationName.of("[ORGANIZATION]", "[LOCATION]");
   for (Workload element : assuredWorkloadsServiceClient.listWorkloads(parent).iterateAll()) {
     // doThingsWith(element);
   }
 }
 

Parameter
Name	Description
parent	LocationName Required. Parent Resource to list workloads from. Must be of the form organizations/{org_id}/locations/{location}.

Returns
Type	Description
AssuredWorkloadsServiceClient.ListWorkloadsPagedResponse

listWorkloads(String parent)

public final AssuredWorkloadsServiceClient.ListWorkloadsPagedResponse listWorkloads(String parent)

Lists Assured Workloads under a CRM Node.

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 (AssuredWorkloadsServiceClient assuredWorkloadsServiceClient =
     AssuredWorkloadsServiceClient.create()) {
   String parent = LocationName.of("[ORGANIZATION]", "[LOCATION]").toString();
   for (Workload element : assuredWorkloadsServiceClient.listWorkloads(parent).iterateAll()) {
     // doThingsWith(element);
   }
 }
 

Parameter
Name	Description
parent	String Required. Parent Resource to list workloads from. Must be of the form organizations/{org_id}/locations/{location}.

Returns
Type	Description
AssuredWorkloadsServiceClient.ListWorkloadsPagedResponse

listWorkloadsCallable()

public final UnaryCallable<ListWorkloadsRequest,ListWorkloadsResponse> listWorkloadsCallable()

Lists Assured Workloads under a CRM Node.

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 (AssuredWorkloadsServiceClient assuredWorkloadsServiceClient =
     AssuredWorkloadsServiceClient.create()) {
   ListWorkloadsRequest request =
       ListWorkloadsRequest.newBuilder()
           .setParent(LocationName.of("[ORGANIZATION]", "[LOCATION]").toString())
           .setPageSize(883849137)
           .setPageToken("pageToken873572522")
           .setFilter("filter-1274492040")
           .build();
   while (true) {
     ListWorkloadsResponse response =
         assuredWorkloadsServiceClient.listWorkloadsCallable().call(request);
     for (Workload element : response.getWorkloadsList()) {
       // doThingsWith(element);
     }
     String nextPageToken = response.getNextPageToken();
     if (!Strings.isNullOrEmpty(nextPageToken)) {
       request = request.toBuilder().setPageToken(nextPageToken).build();
     } else {
       break;
     }
   }
 }
 

Returns
Type	Description
UnaryCallable<ListWorkloadsRequest,ListWorkloadsResponse>

listWorkloadsPagedCallable()

public final UnaryCallable<ListWorkloadsRequest,AssuredWorkloadsServiceClient.ListWorkloadsPagedResponse> listWorkloadsPagedCallable()

Lists Assured Workloads under a CRM Node.

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 (AssuredWorkloadsServiceClient assuredWorkloadsServiceClient =
     AssuredWorkloadsServiceClient.create()) {
   ListWorkloadsRequest request =
       ListWorkloadsRequest.newBuilder()
           .setParent(LocationName.of("[ORGANIZATION]", "[LOCATION]").toString())
           .setPageSize(883849137)
           .setPageToken("pageToken873572522")
           .setFilter("filter-1274492040")
           .build();
   ApiFuture<Workload> future =
       assuredWorkloadsServiceClient.listWorkloadsPagedCallable().futureCall(request);
   // Do something.
   for (Workload element : future.get().iterateAll()) {
     // doThingsWith(element);
   }
 }
 

Returns
Type	Description
UnaryCallable<ListWorkloadsRequest,ListWorkloadsPagedResponse>

restrictAllowedResources(RestrictAllowedResourcesRequest request)

public final RestrictAllowedResourcesResponse restrictAllowedResources(RestrictAllowedResourcesRequest request)

Restrict the list of resources allowed in the Workload environment. The current list of allowed products can be found at https://cloud.google.com/assured-workloads/docs/supported-products In addition to assuredworkloads.workload.update permission, the user should also have orgpolicy.policy.set permission on the folder resource to use this functionality.

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 (AssuredWorkloadsServiceClient assuredWorkloadsServiceClient =
     AssuredWorkloadsServiceClient.create()) {
   RestrictAllowedResourcesRequest request =
       RestrictAllowedResourcesRequest.newBuilder().setName("name3373707").build();
   RestrictAllowedResourcesResponse response =
       assuredWorkloadsServiceClient.restrictAllowedResources(request);
 }
 

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

Returns
Type	Description
RestrictAllowedResourcesResponse

restrictAllowedResourcesCallable()

public final UnaryCallable<RestrictAllowedResourcesRequest,RestrictAllowedResourcesResponse> restrictAllowedResourcesCallable()

Restrict the list of resources allowed in the Workload environment. The current list of allowed products can be found at https://cloud.google.com/assured-workloads/docs/supported-products In addition to assuredworkloads.workload.update permission, the user should also have orgpolicy.policy.set permission on the folder resource to use this functionality.

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 (AssuredWorkloadsServiceClient assuredWorkloadsServiceClient =
     AssuredWorkloadsServiceClient.create()) {
   RestrictAllowedResourcesRequest request =
       RestrictAllowedResourcesRequest.newBuilder().setName("name3373707").build();
   ApiFuture<RestrictAllowedResourcesResponse> future =
       assuredWorkloadsServiceClient.restrictAllowedResourcesCallable().futureCall(request);
   // Do something.
   RestrictAllowedResourcesResponse response = future.get();
 }
 

Returns
Type	Description
UnaryCallable<RestrictAllowedResourcesRequest,RestrictAllowedResourcesResponse>

shutdown()

public void shutdown()

shutdownNow()

public void shutdownNow()

updateWorkload(UpdateWorkloadRequest request)

public final Workload updateWorkload(UpdateWorkloadRequest request)

Updates an existing workload. Currently allows updating of workload display_name and labels. For force updates don't set etag field in the Workload. Only one update operation per workload can be in progress.

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 (AssuredWorkloadsServiceClient assuredWorkloadsServiceClient =
     AssuredWorkloadsServiceClient.create()) {
   UpdateWorkloadRequest request =
       UpdateWorkloadRequest.newBuilder()
           .setWorkload(Workload.newBuilder().build())
           .setUpdateMask(FieldMask.newBuilder().build())
           .build();
   Workload response = assuredWorkloadsServiceClient.updateWorkload(request);
 }
 

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

Returns
Type	Description
Workload

updateWorkload(Workload workload, FieldMask updateMask)

public final Workload updateWorkload(Workload workload, FieldMask updateMask)

Updates an existing workload. Currently allows updating of workload display_name and labels. For force updates don't set etag field in the Workload. Only one update operation per workload can be in progress.

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 (AssuredWorkloadsServiceClient assuredWorkloadsServiceClient =
     AssuredWorkloadsServiceClient.create()) {
   Workload workload = Workload.newBuilder().build();
   FieldMask updateMask = FieldMask.newBuilder().build();
   Workload response = assuredWorkloadsServiceClient.updateWorkload(workload, updateMask);
 }
 

Parameters
Name	Description
workload	Workload Required. The workload to update. The workload's name field is used to identify the workload to be updated. Format: organizations/{org_id}/locations/{location_id}/workloads/{workload_id}
updateMask	FieldMask Required. The list of fields to be updated.

Returns
Type	Description
Workload

updateWorkloadCallable()

public final UnaryCallable<UpdateWorkloadRequest,Workload> updateWorkloadCallable()

Updates an existing workload. Currently allows updating of workload display_name and labels. For force updates don't set etag field in the Workload. Only one update operation per workload can be in progress.

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 (AssuredWorkloadsServiceClient assuredWorkloadsServiceClient =
     AssuredWorkloadsServiceClient.create()) {
   UpdateWorkloadRequest request =
       UpdateWorkloadRequest.newBuilder()
           .setWorkload(Workload.newBuilder().build())
           .setUpdateMask(FieldMask.newBuilder().build())
           .build();
   ApiFuture<Workload> future =
       assuredWorkloadsServiceClient.updateWorkloadCallable().futureCall(request);
   // Do something.
   Workload response = future.get();
 }
 

Returns
Type	Description
UnaryCallable<UpdateWorkloadRequest,Workload>