- 2.49.0 (latest)
- 2.48.0
- 2.47.0
- 2.46.0
- 2.45.0
- 2.44.0
- 2.43.0
- 2.42.0
- 2.41.0
- 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
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
AnalyzeWorkloadMoveRequest
A request to analyze a hypothetical move of a source project or project-based workload to a target (destination) folder-based workload.
Protobuf type google.cloud.assuredworkloads.v1beta1.AnalyzeWorkloadMoveRequest
AnalyzeWorkloadMoveRequest.Builder
A request to analyze a hypothetical move of a source project or project-based workload to a target (destination) folder-based workload.
Protobuf type google.cloud.assuredworkloads.v1beta1.AnalyzeWorkloadMoveRequest
AnalyzeWorkloadMoveResponse
A response that includes the analysis of the hypothetical resource move.
Protobuf type google.cloud.assuredworkloads.v1beta1.AnalyzeWorkloadMoveResponse
AnalyzeWorkloadMoveResponse.Builder
A response that includes the analysis of the hypothetical resource move.
Protobuf type google.cloud.assuredworkloads.v1beta1.AnalyzeWorkloadMoveResponse
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.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
AssuredworkloadsServiceProto
CreateWorkloadOperationMetadata
Operation metadata to give request details of CreateWorkload.
Protobuf type google.cloud.assuredworkloads.v1beta1.CreateWorkloadOperationMetadata
CreateWorkloadOperationMetadata.Builder
Operation metadata to give request details of CreateWorkload.
Protobuf type google.cloud.assuredworkloads.v1beta1.CreateWorkloadOperationMetadata
CreateWorkloadRequest
Request for creating a workload.
Protobuf type google.cloud.assuredworkloads.v1beta1.CreateWorkloadRequest
CreateWorkloadRequest.Builder
Request for creating a workload.
Protobuf type google.cloud.assuredworkloads.v1beta1.CreateWorkloadRequest
DeleteWorkloadRequest
Request for deleting a Workload.
Protobuf type google.cloud.assuredworkloads.v1beta1.DeleteWorkloadRequest
DeleteWorkloadRequest.Builder
Request for deleting a Workload.
Protobuf type google.cloud.assuredworkloads.v1beta1.DeleteWorkloadRequest
GetWorkloadRequest
Request for fetching a workload.
Protobuf type google.cloud.assuredworkloads.v1beta1.GetWorkloadRequest
GetWorkloadRequest.Builder
Request for fetching a workload.
Protobuf type google.cloud.assuredworkloads.v1beta1.GetWorkloadRequest
ListWorkloadsRequest
Request for fetching workloads in an organization.
Protobuf type google.cloud.assuredworkloads.v1beta1.ListWorkloadsRequest
ListWorkloadsRequest.Builder
Request for fetching workloads in an organization.
Protobuf type google.cloud.assuredworkloads.v1beta1.ListWorkloadsRequest
ListWorkloadsResponse
Response of ListWorkloads endpoint.
Protobuf type google.cloud.assuredworkloads.v1beta1.ListWorkloadsResponse
ListWorkloadsResponse.Builder
Response of ListWorkloads endpoint.
Protobuf type google.cloud.assuredworkloads.v1beta1.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.v1beta1.RestrictAllowedResourcesRequest
RestrictAllowedResourcesRequest.Builder
Request for restricting list of available resources in Workload environment.
Protobuf type google.cloud.assuredworkloads.v1beta1.RestrictAllowedResourcesRequest
RestrictAllowedResourcesResponse
Response for restricting the list of allowed resources.
Protobuf type google.cloud.assuredworkloads.v1beta1.RestrictAllowedResourcesResponse
RestrictAllowedResourcesResponse.Builder
Response for restricting the list of allowed resources.
Protobuf type google.cloud.assuredworkloads.v1beta1.RestrictAllowedResourcesResponse
UpdateWorkloadRequest
Request for Updating a workload.
Protobuf type google.cloud.assuredworkloads.v1beta1.UpdateWorkloadRequest
UpdateWorkloadRequest.Builder
Request for Updating a workload.
Protobuf type google.cloud.assuredworkloads.v1beta1.UpdateWorkloadRequest
Workload
An Workload object for managing highly regulated workloads of cloud customers.
Protobuf type google.cloud.assuredworkloads.v1beta1.Workload
Workload.Builder
An Workload object for managing highly regulated workloads of cloud customers.
Protobuf type google.cloud.assuredworkloads.v1beta1.Workload
Workload.CJISSettings
Settings specific to resources needed for CJIS.
Protobuf type google.cloud.assuredworkloads.v1beta1.Workload.CJISSettings
Workload.CJISSettings.Builder
Settings specific to resources needed for CJIS.
Protobuf type google.cloud.assuredworkloads.v1beta1.Workload.CJISSettings
Workload.FedrampHighSettings
Settings specific to resources needed for FedRAMP High.
Protobuf type google.cloud.assuredworkloads.v1beta1.Workload.FedrampHighSettings
Workload.FedrampHighSettings.Builder
Settings specific to resources needed for FedRAMP High.
Protobuf type google.cloud.assuredworkloads.v1beta1.Workload.FedrampHighSettings
Workload.FedrampModerateSettings
Settings specific to resources needed for FedRAMP Moderate.
Protobuf type google.cloud.assuredworkloads.v1beta1.Workload.FedrampModerateSettings
Workload.FedrampModerateSettings.Builder
Settings specific to resources needed for FedRAMP Moderate.
Protobuf type google.cloud.assuredworkloads.v1beta1.Workload.FedrampModerateSettings
Workload.IL4Settings
Settings specific to resources needed for IL4.
Protobuf type google.cloud.assuredworkloads.v1beta1.Workload.IL4Settings
Workload.IL4Settings.Builder
Settings specific to resources needed for IL4.
Protobuf type google.cloud.assuredworkloads.v1beta1.Workload.IL4Settings
Workload.KMSSettings
Settings specific to the Key Management Service.
Protobuf type google.cloud.assuredworkloads.v1beta1.Workload.KMSSettings
Workload.KMSSettings.Builder
Settings specific to the Key Management Service.
Protobuf type google.cloud.assuredworkloads.v1beta1.Workload.KMSSettings
Workload.ResourceInfo
Represent the resources that are children of this Workload.
Protobuf type google.cloud.assuredworkloads.v1beta1.Workload.ResourceInfo
Workload.ResourceInfo.Builder
Represent the resources that are children of this Workload.
Protobuf type google.cloud.assuredworkloads.v1beta1.Workload.ResourceInfo
Workload.ResourceSettings
Represent the custom settings for the resources to be created.
Protobuf type google.cloud.assuredworkloads.v1beta1.Workload.ResourceSettings
Workload.ResourceSettings.Builder
Represent the custom settings for the resources to be created.
Protobuf type google.cloud.assuredworkloads.v1beta1.Workload.ResourceSettings
Workload.SaaEnrollmentResponse
Signed Access Approvals (SAA) enrollment response.
Protobuf type google.cloud.assuredworkloads.v1beta1.Workload.SaaEnrollmentResponse
Workload.SaaEnrollmentResponse.Builder
Signed Access Approvals (SAA) enrollment response.
Protobuf type google.cloud.assuredworkloads.v1beta1.Workload.SaaEnrollmentResponse
WorkloadName
WorkloadName.Builder
Builder for organizations/{organization}/locations/{location}/workloads/{workload}.
Interfaces
AnalyzeWorkloadMoveRequestOrBuilder
AnalyzeWorkloadMoveResponseOrBuilder
AssuredWorkloadsServiceGrpc.AsyncService
Service to manage AssuredWorkloads.
CreateWorkloadOperationMetadataOrBuilder
CreateWorkloadRequestOrBuilder
DeleteWorkloadRequestOrBuilder
GetWorkloadRequestOrBuilder
ListWorkloadsRequestOrBuilder
ListWorkloadsResponseOrBuilder
RestrictAllowedResourcesRequestOrBuilder
RestrictAllowedResourcesResponseOrBuilder
UpdateWorkloadRequestOrBuilder
Workload.CJISSettingsOrBuilder
Workload.FedrampHighSettingsOrBuilder
Workload.FedrampModerateSettingsOrBuilder
Workload.IL4SettingsOrBuilder
Workload.KMSSettingsOrBuilder
Workload.ResourceInfoOrBuilder
Workload.ResourceSettingsOrBuilder
Workload.SaaEnrollmentResponseOrBuilder
WorkloadOrBuilder
Enums
AnalyzeWorkloadMoveRequest.ProjectOrWorkloadResourceCase
RestrictAllowedResourcesRequest.RestrictionType
The type of restriction.
Protobuf enum
google.cloud.assuredworkloads.v1beta1.RestrictAllowedResourcesRequest.RestrictionType
Workload.ComplianceRegime
Supported Compliance Regimes.
Protobuf enum google.cloud.assuredworkloads.v1beta1.Workload.ComplianceRegime
Workload.ComplianceRegimeSettingsCase
Workload.KajEnrollmentState
Key Access Justifications(KAJ) Enrollment State.
Protobuf enum google.cloud.assuredworkloads.v1beta1.Workload.KajEnrollmentState
Workload.ResourceInfo.ResourceType
The type of resource.
Protobuf enum
google.cloud.assuredworkloads.v1beta1.Workload.ResourceInfo.ResourceType
Workload.SaaEnrollmentResponse.SetupError
Setup error of SAA enrollment.
Protobuf enum
google.cloud.assuredworkloads.v1beta1.Workload.SaaEnrollmentResponse.SetupError
Workload.SaaEnrollmentResponse.SetupState
Setup state of SAA enrollment.
Protobuf enum
google.cloud.assuredworkloads.v1beta1.Workload.SaaEnrollmentResponse.SetupState