Assured Workloads v1 API - Class AssuredWorkloadsService.AssuredWorkloadsServiceBase (2.5.0)

[BindServiceMethod(typeof(AssuredWorkloadsService), "BindService")]
public abstract class AssuredWorkloadsService.AssuredWorkloadsServiceBase

Reference documentation and code samples for the Assured Workloads v1 API class AssuredWorkloadsService.AssuredWorkloadsServiceBase.

Base class for server-side implementations of AssuredWorkloadsService

Inheritance

object > AssuredWorkloadsService.AssuredWorkloadsServiceBase

Namespace

Google.Cloud.AssuredWorkloads.V1

Assembly

Google.Cloud.AssuredWorkloads.V1.dll

Methods

AcknowledgeViolation(AcknowledgeViolationRequest, ServerCallContext)

public virtual Task<AcknowledgeViolationResponse> AcknowledgeViolation(AcknowledgeViolationRequest request, ServerCallContext context)

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 AcknowledgeViolationRequest

The request received from the client.

context ServerCallContext

The context of the server-side call handler being invoked.

Returns
Type Description
TaskAcknowledgeViolationResponse

The response to send back to the client (wrapped by a task).

CreateWorkload(CreateWorkloadRequest, ServerCallContext)

public virtual Task<Operation> CreateWorkload(CreateWorkloadRequest request, ServerCallContext context)

Creates Assured Workload.

Parameters
Name Description
request CreateWorkloadRequest

The request received from the client.

context ServerCallContext

The context of the server-side call handler being invoked.

Returns
Type Description
TaskOperation

The response to send back to the client (wrapped by a task).

DeleteWorkload(DeleteWorkloadRequest, ServerCallContext)

public virtual Task<Empty> DeleteWorkload(DeleteWorkloadRequest request, ServerCallContext context)

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 DeleteWorkloadRequest

The request received from the client.

context ServerCallContext

The context of the server-side call handler being invoked.

Returns
Type Description
TaskEmpty

The response to send back to the client (wrapped by a task).

GetViolation(GetViolationRequest, ServerCallContext)

public virtual Task<Violation> GetViolation(GetViolationRequest request, ServerCallContext context)

Retrieves Assured Workload Violation based on ID.

Parameters
Name Description
request GetViolationRequest

The request received from the client.

context ServerCallContext

The context of the server-side call handler being invoked.

Returns
Type Description
TaskViolation

The response to send back to the client (wrapped by a task).

GetWorkload(GetWorkloadRequest, ServerCallContext)

public virtual Task<Workload> GetWorkload(GetWorkloadRequest request, ServerCallContext context)

Gets Assured Workload associated with a CRM Node

Parameters
Name Description
request GetWorkloadRequest

The request received from the client.

context ServerCallContext

The context of the server-side call handler being invoked.

Returns
Type Description
TaskWorkload

The response to send back to the client (wrapped by a task).

ListViolations(ListViolationsRequest, ServerCallContext)

public virtual Task<ListViolationsResponse> ListViolations(ListViolationsRequest request, ServerCallContext context)

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 ListViolationsRequest

The request received from the client.

context ServerCallContext

The context of the server-side call handler being invoked.

Returns
Type Description
TaskListViolationsResponse

The response to send back to the client (wrapped by a task).

ListWorkloads(ListWorkloadsRequest, ServerCallContext)

public virtual Task<ListWorkloadsResponse> ListWorkloads(ListWorkloadsRequest request, ServerCallContext context)

Lists Assured Workloads under a CRM Node.

Parameters
Name Description
request ListWorkloadsRequest

The request received from the client.

context ServerCallContext

The context of the server-side call handler being invoked.

Returns
Type Description
TaskListWorkloadsResponse

The response to send back to the client (wrapped by a task).

RestrictAllowedResources(RestrictAllowedResourcesRequest, ServerCallContext)

public virtual Task<RestrictAllowedResourcesResponse> RestrictAllowedResources(RestrictAllowedResourcesRequest request, ServerCallContext context)

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 RestrictAllowedResourcesRequest

The request received from the client.

context ServerCallContext

The context of the server-side call handler being invoked.

Returns
Type Description
TaskRestrictAllowedResourcesResponse

The response to send back to the client (wrapped by a task).

UpdateWorkload(UpdateWorkloadRequest, ServerCallContext)

public virtual Task<Workload> UpdateWorkload(UpdateWorkloadRequest request, ServerCallContext context)

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 UpdateWorkloadRequest

The request received from the client.

context ServerCallContext

The context of the server-side call handler being invoked.

Returns
Type Description
TaskWorkload

The response to send back to the client (wrapped by a task).