public sealed class AssuredWorkloadsServiceClientImpl : AssuredWorkloadsServiceClientReference documentation and code samples for the Assured Workloads v1 API class AssuredWorkloadsServiceClientImpl.
AssuredWorkloadsService client wrapper implementation, for convenient use.
Namespace
Google.Cloud.AssuredWorkloads.V1Assembly
Google.Cloud.AssuredWorkloads.V1.dll
Remarks
Service to manage AssuredWorkloads.
Constructors
AssuredWorkloadsServiceClientImpl(AssuredWorkloadsService.AssuredWorkloadsServiceClient, AssuredWorkloadsServiceSettings, ILogger)
public AssuredWorkloadsServiceClientImpl(AssuredWorkloadsService.AssuredWorkloadsServiceClient grpcClient, AssuredWorkloadsServiceSettings settings, ILogger logger)Constructs a client wrapper for the AssuredWorkloadsService service, with the specified gRPC client and settings.
| Parameters | |
|---|---|
| Name | Description |
grpcClient | AssuredWorkloadsService.AssuredWorkloadsServiceClientThe underlying gRPC client. |
settings | AssuredWorkloadsServiceSettingsThe base AssuredWorkloadsServiceSettings used within this client. |
logger | ILoggerOptional ILogger to use within this client. |
Properties
CreateWorkloadOperationsClient
public override OperationsClient CreateWorkloadOperationsClient { get; }The long-running operations client for CreateWorkload.
| Property Value | |
|---|---|
| Type | Description |
OperationsClient | |
GrpcClient
public override AssuredWorkloadsService.AssuredWorkloadsServiceClient GrpcClient { get; }The underlying gRPC AssuredWorkloadsService client
| Property Value | |
|---|---|
| Type | Description |
AssuredWorkloadsService.AssuredWorkloadsServiceClient | |
Methods
AcknowledgeViolation(AcknowledgeViolationRequest, CallSettings)
public override AcknowledgeViolationResponse AcknowledgeViolation(AcknowledgeViolationRequest request, CallSettings callSettings = null)Acknowledges an existing violation. By acknowledging a violation, users acknowledge the existence of a compliance violation in their workload and decide to ignore it due to a valid business justification. Acknowledgement is a permanent operation and it cannot be reverted.
| Parameters | |
|---|---|
| Name | Description |
request | AcknowledgeViolationRequestThe request object containing all of the parameters for the API call. |
callSettings | CallSettingsIf not null, applies overrides to this RPC call. |
| Returns | |
|---|---|
| Type | Description |
AcknowledgeViolationResponse | The RPC response. |
AcknowledgeViolationAsync(AcknowledgeViolationRequest, CallSettings)
public override Task<AcknowledgeViolationResponse> AcknowledgeViolationAsync(AcknowledgeViolationRequest request, CallSettings callSettings = null)Acknowledges an existing violation. By acknowledging a violation, users acknowledge the existence of a compliance violation in their workload and decide to ignore it due to a valid business justification. Acknowledgement is a permanent operation and it cannot be reverted.
| Parameters | |
|---|---|
| Name | Description |
request | AcknowledgeViolationRequestThe request object containing all of the parameters for the API call. |
callSettings | CallSettingsIf not null, applies overrides to this RPC call. |
| Returns | |
|---|---|
| Type | Description |
Task<AcknowledgeViolationResponse> | A Task containing the RPC response. |
CreateWorkload(CreateWorkloadRequest, CallSettings)
public override Operation<Workload, CreateWorkloadOperationMetadata> CreateWorkload(CreateWorkloadRequest request, CallSettings callSettings = null)Creates Assured Workload.
| Parameters | |
|---|---|
| Name | Description |
request | CreateWorkloadRequestThe request object containing all of the parameters for the API call. |
callSettings | CallSettingsIf not null, applies overrides to this RPC call. |
| Returns | |
|---|---|
| Type | Description |
Operation<Workload, CreateWorkloadOperationMetadata> | The RPC response. |
CreateWorkloadAsync(CreateWorkloadRequest, CallSettings)
public override async Task<Operation<Workload, CreateWorkloadOperationMetadata>> CreateWorkloadAsync(CreateWorkloadRequest request, CallSettings callSettings = null)Creates Assured Workload.
| Parameters | |
|---|---|
| Name | Description |
request | CreateWorkloadRequestThe request object containing all of the parameters for the API call. |
callSettings | CallSettingsIf not null, applies overrides to this RPC call. |
| Returns | |
|---|---|
| Type | Description |
Task<Operation<Workload, CreateWorkloadOperationMetadata>> | A Task containing the RPC response. |
DeleteWorkload(DeleteWorkloadRequest, CallSettings)
public override void DeleteWorkload(DeleteWorkloadRequest request, CallSettings callSettings = null)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.
| Parameters | |
|---|---|
| Name | Description |
request | DeleteWorkloadRequestThe request object containing all of the parameters for the API call. |
callSettings | CallSettingsIf not null, applies overrides to this RPC call. |
DeleteWorkloadAsync(DeleteWorkloadRequest, CallSettings)
public override Task DeleteWorkloadAsync(DeleteWorkloadRequest request, CallSettings callSettings = null)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.
| Parameters | |
|---|---|
| Name | Description |
request | DeleteWorkloadRequestThe request object containing all of the parameters for the API call. |
callSettings | CallSettingsIf not null, applies overrides to this RPC call. |
| Returns | |
|---|---|
| Type | Description |
Task | A Task containing the RPC response. |
GetViolation(GetViolationRequest, CallSettings)
public override Violation GetViolation(GetViolationRequest request, CallSettings callSettings = null)Retrieves Assured Workload Violation based on ID.
| Parameters | |
|---|---|
| Name | Description |
request | GetViolationRequestThe request object containing all of the parameters for the API call. |
callSettings | CallSettingsIf not null, applies overrides to this RPC call. |
| Returns | |
|---|---|
| Type | Description |
Violation | The RPC response. |
GetViolationAsync(GetViolationRequest, CallSettings)
public override Task<Violation> GetViolationAsync(GetViolationRequest request, CallSettings callSettings = null)Retrieves Assured Workload Violation based on ID.
| Parameters | |
|---|---|
| Name | Description |
request | GetViolationRequestThe request object containing all of the parameters for the API call. |
callSettings | CallSettingsIf not null, applies overrides to this RPC call. |
| Returns | |
|---|---|
| Type | Description |
Task<Violation> | A Task containing the RPC response. |
GetWorkload(GetWorkloadRequest, CallSettings)
public override Workload GetWorkload(GetWorkloadRequest request, CallSettings callSettings = null)Gets Assured Workload associated with a CRM Node
| Parameters | |
|---|---|
| Name | Description |
request | GetWorkloadRequestThe request object containing all of the parameters for the API call. |
callSettings | CallSettingsIf not null, applies overrides to this RPC call. |
| Returns | |
|---|---|
| Type | Description |
Workload | The RPC response. |
GetWorkloadAsync(GetWorkloadRequest, CallSettings)
public override Task<Workload> GetWorkloadAsync(GetWorkloadRequest request, CallSettings callSettings = null)Gets Assured Workload associated with a CRM Node
| Parameters | |
|---|---|
| Name | Description |
request | GetWorkloadRequestThe request object containing all of the parameters for the API call. |
callSettings | CallSettingsIf not null, applies overrides to this RPC call. |
| Returns | |
|---|---|
| Type | Description |
Task<Workload> | A Task containing the RPC response. |
ListViolations(ListViolationsRequest, CallSettings)
public override PagedEnumerable<ListViolationsResponse, Violation> ListViolations(ListViolationsRequest request, CallSettings callSettings = null)Lists the Violations in the AssuredWorkload Environment.
Callers may also choose to read across multiple Workloads as per
AIP-159 by using '-' (the hyphen or dash
character) as a wildcard character instead of workload-id in the parent.
Format organizations/{org_id}/locations/{location}/workloads/-
| Parameters | |
|---|---|
| Name | Description |
request | ListViolationsRequestThe request object containing all of the parameters for the API call. |
callSettings | CallSettingsIf not null, applies overrides to this RPC call. |
| Returns | |
|---|---|
| Type | Description |
PagedEnumerable<ListViolationsResponse, Violation> | A pageable sequence of Violation resources. |
ListViolationsAsync(ListViolationsRequest, CallSettings)
public override PagedAsyncEnumerable<ListViolationsResponse, Violation> ListViolationsAsync(ListViolationsRequest request, CallSettings callSettings = null)Lists the Violations in the AssuredWorkload Environment.
Callers may also choose to read across multiple Workloads as per
AIP-159 by using '-' (the hyphen or dash
character) as a wildcard character instead of workload-id in the parent.
Format organizations/{org_id}/locations/{location}/workloads/-
| Parameters | |
|---|---|
| Name | Description |
request | ListViolationsRequestThe request object containing all of the parameters for the API call. |
callSettings | CallSettingsIf not null, applies overrides to this RPC call. |
| Returns | |
|---|---|
| Type | Description |
PagedAsyncEnumerable<ListViolationsResponse, Violation> | A pageable asynchronous sequence of Violation resources. |
ListWorkloads(ListWorkloadsRequest, CallSettings)
public override PagedEnumerable<ListWorkloadsResponse, Workload> ListWorkloads(ListWorkloadsRequest request, CallSettings callSettings = null)Lists Assured Workloads under a CRM Node.
| Parameters | |
|---|---|
| Name | Description |
request | ListWorkloadsRequestThe request object containing all of the parameters for the API call. |
callSettings | CallSettingsIf not null, applies overrides to this RPC call. |
| Returns | |
|---|---|
| Type | Description |
PagedEnumerable<ListWorkloadsResponse, Workload> | A pageable sequence of Workload resources. |
ListWorkloadsAsync(ListWorkloadsRequest, CallSettings)
public override PagedAsyncEnumerable<ListWorkloadsResponse, Workload> ListWorkloadsAsync(ListWorkloadsRequest request, CallSettings callSettings = null)Lists Assured Workloads under a CRM Node.
| Parameters | |
|---|---|
| Name | Description |
request | ListWorkloadsRequestThe request object containing all of the parameters for the API call. |
callSettings | CallSettingsIf not null, applies overrides to this RPC call. |
| Returns | |
|---|---|
| Type | Description |
PagedAsyncEnumerable<ListWorkloadsResponse, Workload> | A pageable asynchronous sequence of Workload resources. |
RestrictAllowedResources(RestrictAllowedResourcesRequest, CallSettings)
public override RestrictAllowedResourcesResponse RestrictAllowedResources(RestrictAllowedResourcesRequest request, CallSettings callSettings = null)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.
| Parameters | |
|---|---|
| Name | Description |
request | RestrictAllowedResourcesRequestThe request object containing all of the parameters for the API call. |
callSettings | CallSettingsIf not null, applies overrides to this RPC call. |
| Returns | |
|---|---|
| Type | Description |
RestrictAllowedResourcesResponse | The RPC response. |
RestrictAllowedResourcesAsync(RestrictAllowedResourcesRequest, CallSettings)
public override Task<RestrictAllowedResourcesResponse> RestrictAllowedResourcesAsync(RestrictAllowedResourcesRequest request, CallSettings callSettings = null)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.
| Parameters | |
|---|---|
| Name | Description |
request | RestrictAllowedResourcesRequestThe request object containing all of the parameters for the API call. |
callSettings | CallSettingsIf not null, applies overrides to this RPC call. |
| Returns | |
|---|---|
| Type | Description |
Task<RestrictAllowedResourcesResponse> | A Task containing the RPC response. |
UpdateWorkload(UpdateWorkloadRequest, CallSettings)
public override Workload UpdateWorkload(UpdateWorkloadRequest request, CallSettings callSettings = null)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.
| Parameters | |
|---|---|
| Name | Description |
request | UpdateWorkloadRequestThe request object containing all of the parameters for the API call. |
callSettings | CallSettingsIf not null, applies overrides to this RPC call. |
| Returns | |
|---|---|
| Type | Description |
Workload | The RPC response. |
UpdateWorkloadAsync(UpdateWorkloadRequest, CallSettings)
public override Task<Workload> UpdateWorkloadAsync(UpdateWorkloadRequest request, CallSettings callSettings = null)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.
| Parameters | |
|---|---|
| Name | Description |
request | UpdateWorkloadRequestThe request object containing all of the parameters for the API call. |
callSettings | CallSettingsIf not null, applies overrides to this RPC call. |
| Returns | |
|---|---|
| Type | Description |
Task<Workload> | A Task containing the RPC response. |