- 2.54.0 (latest)
- 2.53.0
- 2.52.0
- 2.51.0
- 2.49.0
- 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 for illustrative purposes only.
// It may require modifications to work in your environment.
try (AssuredWorkloadsServiceClient assuredWorkloadsServiceClient =
AssuredWorkloadsServiceClient.create()) {
Workload workload = Workload.newBuilder().build();
FieldMask updateMask = FieldMask.newBuilder().build();
Workload response = assuredWorkloadsServiceClient.updateWorkload(workload, updateMask);
}
Classes
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 for illustrative purposes only.
// It may require modifications to work in your environment.
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 for illustrative purposes only.
// It may require modifications to work in your environment.
AssuredWorkloadsServiceSettings assuredWorkloadsServiceSettings =
AssuredWorkloadsServiceSettings.newBuilder()
.setCredentialsProvider(FixedCredentialsProvider.create(myCredentials))
.build();
AssuredWorkloadsServiceClient assuredWorkloadsServiceClient =
AssuredWorkloadsServiceClient.create(assuredWorkloadsServiceSettings);
To customize the endpoint:
// This snippet has been automatically generated for illustrative purposes only.
// It may require modifications to work in your environment.
AssuredWorkloadsServiceSettings assuredWorkloadsServiceSettings =
AssuredWorkloadsServiceSettings.newBuilder().setEndpoint(myEndpoint).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
Service to manage AssuredWorkloads.
AssuredWorkloadsServiceGrpc.AssuredWorkloadsServiceFutureStub
Service to manage AssuredWorkloads.
AssuredWorkloadsServiceGrpc.AssuredWorkloadsServiceImplBase
Service to manage AssuredWorkloads.
AssuredWorkloadsServiceGrpc.AssuredWorkloadsServiceStub
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 for illustrative purposes only.
// It may require modifications to work in your environment.
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
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
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}.
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
Workload
An Workload object for managing highly regulated workloads of cloud customers.
Protobuf type google.cloud.assuredworkloads.v1.Workload
Workload.Builder
An 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.
Protobuf type google.cloud.assuredworkloads.v1.Workload.KMSSettings
Workload.KMSSettings.Builder
Settings specific to the Key Management Service.
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
CreateWorkloadOperationMetadataOrBuilder
CreateWorkloadRequestOrBuilder
DeleteWorkloadRequestOrBuilder
GetWorkloadRequestOrBuilder
ListWorkloadsRequestOrBuilder
ListWorkloadsResponseOrBuilder
UpdateWorkloadRequestOrBuilder
Workload.KMSSettingsOrBuilder
Workload.ResourceInfoOrBuilder
Workload.ResourceSettingsOrBuilder
Workload.SaaEnrollmentResponseOrBuilder
WorkloadOrBuilder
Enums
Workload.ComplianceRegime
Supported Compliance Regimes.
Protobuf enum google.cloud.assuredworkloads.v1.Workload.ComplianceRegime
Workload.KajEnrollmentState
Key Access Justifications(KAJ) Enrollment State.
Protobuf enum google.cloud.assuredworkloads.v1.Workload.KajEnrollmentState
Workload.ResourceInfo.ResourceType
The type of resource.
Protobuf enum google.cloud.assuredworkloads.v1.Workload.ResourceInfo.ResourceType
Workload.SaaEnrollmentResponse.SetupError
Setup error of SAA enrollment.
Protobuf enum
google.cloud.assuredworkloads.v1.Workload.SaaEnrollmentResponse.SetupError
Workload.SaaEnrollmentResponse.SetupState
Setup state of SAA enrollment.
Protobuf enum
google.cloud.assuredworkloads.v1.Workload.SaaEnrollmentResponse.SetupState