Package com.google.cloud.assuredworkloads.v1 (2.29.0)

A client to Assured Workloads API

The interfaces provided are listed below, along with usage samples.

AssuredWorkloadsServiceClient

Service Description: Service to manage AssuredWorkloads.

Sample for AssuredWorkloadsServiceClient:


 // 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);
 }

Classes

AcknowledgeViolationRequest

Request for acknowledging the violation Next Id: 4

Protobuf type google.cloud.assuredworkloads.v1.AcknowledgeViolationRequest

AcknowledgeViolationRequest.Builder

Request for acknowledging the violation Next Id: 4

Protobuf type google.cloud.assuredworkloads.v1.AcknowledgeViolationRequest

AcknowledgeViolationResponse

Response for violation acknowledgement

Protobuf type google.cloud.assuredworkloads.v1.AcknowledgeViolationResponse

AcknowledgeViolationResponse.Builder

Response for violation acknowledgement

Protobuf type google.cloud.assuredworkloads.v1.AcknowledgeViolationResponse

AssuredWorkloadsServiceClient

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

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

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

See the individual methods for example code.

Many parameters require resource names to be formatted in a particular way. To assist with these names, this class includes a format method for each type of name, and additionally a parse method to extract the individual identifiers contained within names that are returned.

This class can be customized by passing in a custom instance of 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.

AssuredWorkloadsServiceClient.ListViolationsFixedSizeCollection

AssuredWorkloadsServiceClient.ListViolationsPage

AssuredWorkloadsServiceClient.ListViolationsPagedResponse

AssuredWorkloadsServiceClient.ListWorkloadsFixedSizeCollection

AssuredWorkloadsServiceClient.ListWorkloadsPage

AssuredWorkloadsServiceClient.ListWorkloadsPagedResponse

AssuredWorkloadsServiceGrpc

Service to manage AssuredWorkloads.

AssuredWorkloadsServiceGrpc.AssuredWorkloadsServiceBlockingStub

A stub to allow clients to do synchronous rpc calls to service AssuredWorkloadsService.

Service to manage AssuredWorkloads.

AssuredWorkloadsServiceGrpc.AssuredWorkloadsServiceFutureStub

A stub to allow clients to do ListenableFuture-style rpc calls to service AssuredWorkloadsService.

Service to manage AssuredWorkloads.

AssuredWorkloadsServiceGrpc.AssuredWorkloadsServiceImplBase

Base class for the server implementation of the service AssuredWorkloadsService.

Service to manage AssuredWorkloads.

AssuredWorkloadsServiceGrpc.AssuredWorkloadsServiceStub

A stub to allow clients to do asynchronous rpc calls to service AssuredWorkloadsService.

Service to manage AssuredWorkloads.

AssuredWorkloadsServiceSettings

Settings class to configure an instance of AssuredWorkloadsServiceClient.

The default instance has everything set to sensible defaults:

The default service address (assuredworkloads.googleapis.com) and default port (443) are used.
Credentials are acquired automatically through Application Default Credentials.
Retries are configured for idempotent methods but not for non-idempotent methods.

The builder of this class is recursive, so contained classes are themselves builders. When build() is called, the tree of builders is called to create the complete settings object.

For example, to set the total timeout of updateWorkload to 30 seconds:


 // 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.Builder assuredWorkloadsServiceSettingsBuilder =
     AssuredWorkloadsServiceSettings.newBuilder();
 assuredWorkloadsServiceSettingsBuilder
     .updateWorkloadSettings()
     .setRetrySettings(
         assuredWorkloadsServiceSettingsBuilder
             .updateWorkloadSettings()
             .getRetrySettings()
             .toBuilder()
             .setTotalTimeout(Duration.ofSeconds(30))
             .build());
 AssuredWorkloadsServiceSettings assuredWorkloadsServiceSettings =
     assuredWorkloadsServiceSettingsBuilder.build();

AssuredWorkloadsServiceSettings.Builder

Builder for AssuredWorkloadsServiceSettings.

AssuredworkloadsProto

CreateWorkloadOperationMetadata

Operation metadata to give request details of CreateWorkload.

Protobuf type google.cloud.assuredworkloads.v1.CreateWorkloadOperationMetadata

CreateWorkloadOperationMetadata.Builder

Operation metadata to give request details of CreateWorkload.

Protobuf type google.cloud.assuredworkloads.v1.CreateWorkloadOperationMetadata

CreateWorkloadRequest

Request for creating a workload.

Protobuf type google.cloud.assuredworkloads.v1.CreateWorkloadRequest

CreateWorkloadRequest.Builder

Request for creating a workload.

Protobuf type google.cloud.assuredworkloads.v1.CreateWorkloadRequest

DeleteWorkloadRequest

Request for deleting a Workload.

Protobuf type google.cloud.assuredworkloads.v1.DeleteWorkloadRequest

DeleteWorkloadRequest.Builder

Request for deleting a Workload.

Protobuf type google.cloud.assuredworkloads.v1.DeleteWorkloadRequest

GetViolationRequest

Request for fetching a Workload Violation.

Protobuf type google.cloud.assuredworkloads.v1.GetViolationRequest

GetViolationRequest.Builder

Request for fetching a Workload Violation.

Protobuf type google.cloud.assuredworkloads.v1.GetViolationRequest

GetWorkloadRequest

Request for fetching a workload.

Protobuf type google.cloud.assuredworkloads.v1.GetWorkloadRequest

GetWorkloadRequest.Builder

Request for fetching a workload.

Protobuf type google.cloud.assuredworkloads.v1.GetWorkloadRequest

ListViolationsRequest

Request for fetching violations in an organization.

Protobuf type google.cloud.assuredworkloads.v1.ListViolationsRequest

ListViolationsRequest.Builder

Request for fetching violations in an organization.

Protobuf type google.cloud.assuredworkloads.v1.ListViolationsRequest

ListViolationsResponse

Response of ListViolations endpoint.

Protobuf type google.cloud.assuredworkloads.v1.ListViolationsResponse

ListViolationsResponse.Builder

Response of ListViolations endpoint.

Protobuf type google.cloud.assuredworkloads.v1.ListViolationsResponse

ListWorkloadsRequest

Request for fetching workloads in an organization.

Protobuf type google.cloud.assuredworkloads.v1.ListWorkloadsRequest

ListWorkloadsRequest.Builder

Request for fetching workloads in an organization.

Protobuf type google.cloud.assuredworkloads.v1.ListWorkloadsRequest

ListWorkloadsResponse

Response of ListWorkloads endpoint.

Protobuf type google.cloud.assuredworkloads.v1.ListWorkloadsResponse

ListWorkloadsResponse.Builder

Response of ListWorkloads endpoint.

Protobuf type google.cloud.assuredworkloads.v1.ListWorkloadsResponse

LocationName

LocationName.Builder

Builder for organizations/{organization}/locations/{location}.

RestrictAllowedResourcesRequest

Request for restricting list of available resources in Workload environment.

Protobuf type google.cloud.assuredworkloads.v1.RestrictAllowedResourcesRequest

RestrictAllowedResourcesRequest.Builder

Request for restricting list of available resources in Workload environment.

Protobuf type google.cloud.assuredworkloads.v1.RestrictAllowedResourcesRequest

RestrictAllowedResourcesResponse

Response for restricting the list of allowed resources.

Protobuf type google.cloud.assuredworkloads.v1.RestrictAllowedResourcesResponse

RestrictAllowedResourcesResponse.Builder

Response for restricting the list of allowed resources.

Protobuf type google.cloud.assuredworkloads.v1.RestrictAllowedResourcesResponse

TimeWindow

Interval defining a time window.

Protobuf type google.cloud.assuredworkloads.v1.TimeWindow

TimeWindow.Builder

Interval defining a time window.

Protobuf type google.cloud.assuredworkloads.v1.TimeWindow

UpdateWorkloadRequest

Request for Updating a workload.

Protobuf type google.cloud.assuredworkloads.v1.UpdateWorkloadRequest

UpdateWorkloadRequest.Builder

Request for Updating a workload.

Protobuf type google.cloud.assuredworkloads.v1.UpdateWorkloadRequest

Violation

Workload monitoring Violation.

Protobuf type google.cloud.assuredworkloads.v1.Violation

Violation.Builder

Workload monitoring Violation.

Protobuf type google.cloud.assuredworkloads.v1.Violation

Violation.Remediation

Represents remediation guidance to resolve compliance violation for AssuredWorkload

Protobuf type google.cloud.assuredworkloads.v1.Violation.Remediation

Violation.Remediation.Builder

Represents remediation guidance to resolve compliance violation for AssuredWorkload

Protobuf type google.cloud.assuredworkloads.v1.Violation.Remediation

Violation.Remediation.Instructions

Instructions to remediate violation

Protobuf type google.cloud.assuredworkloads.v1.Violation.Remediation.Instructions

Violation.Remediation.Instructions.Builder

Instructions to remediate violation

Protobuf type google.cloud.assuredworkloads.v1.Violation.Remediation.Instructions

Violation.Remediation.Instructions.Console

Remediation instructions to resolve violation via cloud console

Protobuf type google.cloud.assuredworkloads.v1.Violation.Remediation.Instructions.Console

Violation.Remediation.Instructions.Console.Builder

Remediation instructions to resolve violation via cloud console

Protobuf type google.cloud.assuredworkloads.v1.Violation.Remediation.Instructions.Console

Violation.Remediation.Instructions.Gcloud

Remediation instructions to resolve violation via gcloud cli

Protobuf type google.cloud.assuredworkloads.v1.Violation.Remediation.Instructions.Gcloud

Violation.Remediation.Instructions.Gcloud.Builder

Remediation instructions to resolve violation via gcloud cli

Protobuf type google.cloud.assuredworkloads.v1.Violation.Remediation.Instructions.Gcloud

ViolationName

ViolationName.Builder

Builder for organizations/{organization}/locations/{location}/workloads/{workload}/violations/{violation}.

Workload

A Workload object for managing highly regulated workloads of cloud customers.

Protobuf type google.cloud.assuredworkloads.v1.Workload

Workload.Builder

A Workload object for managing highly regulated workloads of cloud customers.

Protobuf type google.cloud.assuredworkloads.v1.Workload

Workload.KMSSettings

Settings specific to the Key Management Service. This message is deprecated. In order to create a Keyring, callers should specify, ENCRYPTION_KEYS_PROJECT or KEYRING in ResourceSettings.resource_type field.

Protobuf type google.cloud.assuredworkloads.v1.Workload.KMSSettings

Workload.KMSSettings.Builder

Protobuf type google.cloud.assuredworkloads.v1.Workload.KMSSettings

Workload.ResourceInfo

Represent the resources that are children of this Workload.

Protobuf type google.cloud.assuredworkloads.v1.Workload.ResourceInfo

Workload.ResourceInfo.Builder

Represent the resources that are children of this Workload.

Protobuf type google.cloud.assuredworkloads.v1.Workload.ResourceInfo

Workload.ResourceSettings

Represent the custom settings for the resources to be created.

Protobuf type google.cloud.assuredworkloads.v1.Workload.ResourceSettings

Workload.ResourceSettings.Builder

Represent the custom settings for the resources to be created.

Protobuf type google.cloud.assuredworkloads.v1.Workload.ResourceSettings

Workload.SaaEnrollmentResponse

Signed Access Approvals (SAA) enrollment response.

Protobuf type google.cloud.assuredworkloads.v1.Workload.SaaEnrollmentResponse

Workload.SaaEnrollmentResponse.Builder

Signed Access Approvals (SAA) enrollment response.

Protobuf type google.cloud.assuredworkloads.v1.Workload.SaaEnrollmentResponse

WorkloadName

WorkloadName.Builder

Builder for organizations/{organization}/locations/{location}/workloads/{workload}.

Interfaces

AcknowledgeViolationRequestOrBuilder

AcknowledgeViolationResponseOrBuilder

AssuredWorkloadsServiceGrpc.AsyncService

Service to manage AssuredWorkloads.

CreateWorkloadOperationMetadataOrBuilder

CreateWorkloadRequestOrBuilder

DeleteWorkloadRequestOrBuilder

GetViolationRequestOrBuilder

GetWorkloadRequestOrBuilder

ListViolationsRequestOrBuilder

ListViolationsResponseOrBuilder

ListWorkloadsRequestOrBuilder

ListWorkloadsResponseOrBuilder

RestrictAllowedResourcesRequestOrBuilder

RestrictAllowedResourcesResponseOrBuilder

TimeWindowOrBuilder

UpdateWorkloadRequestOrBuilder

Violation.Remediation.Instructions.ConsoleOrBuilder

Violation.Remediation.Instructions.GcloudOrBuilder

Violation.Remediation.InstructionsOrBuilder

Violation.RemediationOrBuilder

ViolationOrBuilder

Workload.KMSSettingsOrBuilder

Workload.ResourceInfoOrBuilder

Workload.ResourceSettingsOrBuilder

Workload.SaaEnrollmentResponseOrBuilder

WorkloadOrBuilder

Enums

RestrictAllowedResourcesRequest.RestrictionType

The type of restriction.

Protobuf enum google.cloud.assuredworkloads.v1.RestrictAllowedResourcesRequest.RestrictionType

Violation.Remediation.RemediationType

Classifying remediation into various types based on the kind of violation. For example, violations caused due to changes in boolean org policy requires different remediation instructions compared to violation caused due to changes in allowed values of list org policy.

Protobuf enum google.cloud.assuredworkloads.v1.Violation.Remediation.RemediationType