Assured Workloads v1beta1 API - Class AssuredWorkloadsService.AssuredWorkloadsServiceClient (2.0.0-beta08)

public class AssuredWorkloadsService.AssuredWorkloadsServiceClient : ClientBase<AssuredWorkloadsService.AssuredWorkloadsServiceClient>

Reference documentation and code samples for the Assured Workloads v1beta1 API class AssuredWorkloadsService.AssuredWorkloadsServiceClient.

Client for AssuredWorkloadsService

Inheritance

object > ClientBase > ClientBaseAssuredWorkloadsServiceAssuredWorkloadsServiceClient > AssuredWorkloadsService.AssuredWorkloadsServiceClient

Namespace

Google.Cloud.AssuredWorkloads.V1Beta1

Assembly

Google.Cloud.AssuredWorkloads.V1Beta1.dll

Constructors

AssuredWorkloadsServiceClient()

protected AssuredWorkloadsServiceClient()

Protected parameterless constructor to allow creation of test doubles.

AssuredWorkloadsServiceClient(CallInvoker)

public AssuredWorkloadsServiceClient(CallInvoker callInvoker)

Creates a new client for AssuredWorkloadsService that uses a custom CallInvoker.

Parameter
Name Description
callInvoker CallInvoker

The callInvoker to use to make remote calls.

AssuredWorkloadsServiceClient(ChannelBase)

public AssuredWorkloadsServiceClient(ChannelBase channel)

Creates a new client for AssuredWorkloadsService

Parameter
Name Description
channel ChannelBase

The channel to use to make remote calls.

AssuredWorkloadsServiceClient(ClientBaseConfiguration)

protected AssuredWorkloadsServiceClient(ClientBase.ClientBaseConfiguration configuration)

Protected constructor to allow creation of configured clients.

Parameter
Name Description
configuration ClientBaseClientBaseConfiguration

The client configuration.

Methods

AnalyzeWorkloadMove(AnalyzeWorkloadMoveRequest, CallOptions)

public virtual AnalyzeWorkloadMoveResponse AnalyzeWorkloadMove(AnalyzeWorkloadMoveRequest request, CallOptions options)

Analyze if the source Assured Workloads can be moved to the target Assured Workload

Parameters
Name Description
request AnalyzeWorkloadMoveRequest

The request to send to the server.

options CallOptions

The options for the call.

Returns
Type Description
AnalyzeWorkloadMoveResponse

The response received from the server.

AnalyzeWorkloadMove(AnalyzeWorkloadMoveRequest, Metadata, DateTime?, CancellationToken)

public virtual AnalyzeWorkloadMoveResponse AnalyzeWorkloadMove(AnalyzeWorkloadMoveRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

Analyze if the source Assured Workloads can be moved to the target Assured Workload

Parameters
Name Description
request AnalyzeWorkloadMoveRequest

The request to send to the server.

headers Metadata

The initial metadata to send with the call. This parameter is optional.

deadline DateTime

An optional deadline for the call. The call will be cancelled if deadline is hit.

cancellationToken CancellationToken

An optional token for canceling the call.

Returns
Type Description
AnalyzeWorkloadMoveResponse

The response received from the server.

AnalyzeWorkloadMoveAsync(AnalyzeWorkloadMoveRequest, CallOptions)

public virtual AsyncUnaryCall<AnalyzeWorkloadMoveResponse> AnalyzeWorkloadMoveAsync(AnalyzeWorkloadMoveRequest request, CallOptions options)

Analyze if the source Assured Workloads can be moved to the target Assured Workload

Parameters
Name Description
request AnalyzeWorkloadMoveRequest

The request to send to the server.

options CallOptions

The options for the call.

Returns
Type Description
AsyncUnaryCallAnalyzeWorkloadMoveResponse

The call object.

AnalyzeWorkloadMoveAsync(AnalyzeWorkloadMoveRequest, Metadata, DateTime?, CancellationToken)

public virtual AsyncUnaryCall<AnalyzeWorkloadMoveResponse> AnalyzeWorkloadMoveAsync(AnalyzeWorkloadMoveRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

Analyze if the source Assured Workloads can be moved to the target Assured Workload

Parameters
Name Description
request AnalyzeWorkloadMoveRequest

The request to send to the server.

headers Metadata

The initial metadata to send with the call. This parameter is optional.

deadline DateTime

An optional deadline for the call. The call will be cancelled if deadline is hit.

cancellationToken CancellationToken

An optional token for canceling the call.

Returns
Type Description
AsyncUnaryCallAnalyzeWorkloadMoveResponse

The call object.

CreateOperationsClient()

public virtual Operations.OperationsClient CreateOperationsClient()

Creates a new instance of Operations.OperationsClient using the same call invoker as this client.

Returns
Type Description
OperationsOperationsClient

A new Operations client for the same target as this client.

CreateWorkload(CreateWorkloadRequest, CallOptions)

public virtual Operation CreateWorkload(CreateWorkloadRequest request, CallOptions options)

Creates Assured Workload.

Parameters
Name Description
request CreateWorkloadRequest

The request to send to the server.

options CallOptions

The options for the call.

Returns
Type Description
Operation

The response received from the server.

CreateWorkload(CreateWorkloadRequest, Metadata, DateTime?, CancellationToken)

public virtual Operation CreateWorkload(CreateWorkloadRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

Creates Assured Workload.

Parameters
Name Description
request CreateWorkloadRequest

The request to send to the server.

headers Metadata

The initial metadata to send with the call. This parameter is optional.

deadline DateTime

An optional deadline for the call. The call will be cancelled if deadline is hit.

cancellationToken CancellationToken

An optional token for canceling the call.

Returns
Type Description
Operation

The response received from the server.

CreateWorkloadAsync(CreateWorkloadRequest, CallOptions)

public virtual AsyncUnaryCall<Operation> CreateWorkloadAsync(CreateWorkloadRequest request, CallOptions options)

Creates Assured Workload.

Parameters
Name Description
request CreateWorkloadRequest

The request to send to the server.

options CallOptions

The options for the call.

Returns
Type Description
AsyncUnaryCallOperation

The call object.

CreateWorkloadAsync(CreateWorkloadRequest, Metadata, DateTime?, CancellationToken)

public virtual AsyncUnaryCall<Operation> CreateWorkloadAsync(CreateWorkloadRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

Creates Assured Workload.

Parameters
Name Description
request CreateWorkloadRequest

The request to send to the server.

headers Metadata

The initial metadata to send with the call. This parameter is optional.

deadline DateTime

An optional deadline for the call. The call will be cancelled if deadline is hit.

cancellationToken CancellationToken

An optional token for canceling the call.

Returns
Type Description
AsyncUnaryCallOperation

The call object.

DeleteWorkload(DeleteWorkloadRequest, CallOptions)

public virtual Empty DeleteWorkload(DeleteWorkloadRequest request, CallOptions options)

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. In addition to assuredworkloads.workload.delete permission, the user should also have orgpolicy.policy.set permission on the deleted folder to remove Assured Workloads OrgPolicies.

Parameters
Name Description
request DeleteWorkloadRequest

The request to send to the server.

options CallOptions

The options for the call.

Returns
Type Description
Empty

The response received from the server.

DeleteWorkload(DeleteWorkloadRequest, Metadata, DateTime?, CancellationToken)

public virtual Empty DeleteWorkload(DeleteWorkloadRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

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. In addition to assuredworkloads.workload.delete permission, the user should also have orgpolicy.policy.set permission on the deleted folder to remove Assured Workloads OrgPolicies.

Parameters
Name Description
request DeleteWorkloadRequest

The request to send to the server.

headers Metadata

The initial metadata to send with the call. This parameter is optional.

deadline DateTime

An optional deadline for the call. The call will be cancelled if deadline is hit.

cancellationToken CancellationToken

An optional token for canceling the call.

Returns
Type Description
Empty

The response received from the server.

DeleteWorkloadAsync(DeleteWorkloadRequest, CallOptions)

public virtual AsyncUnaryCall<Empty> DeleteWorkloadAsync(DeleteWorkloadRequest request, CallOptions options)

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. In addition to assuredworkloads.workload.delete permission, the user should also have orgpolicy.policy.set permission on the deleted folder to remove Assured Workloads OrgPolicies.

Parameters
Name Description
request DeleteWorkloadRequest

The request to send to the server.

options CallOptions

The options for the call.

Returns
Type Description
AsyncUnaryCallEmpty

The call object.

DeleteWorkloadAsync(DeleteWorkloadRequest, Metadata, DateTime?, CancellationToken)

public virtual AsyncUnaryCall<Empty> DeleteWorkloadAsync(DeleteWorkloadRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

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. In addition to assuredworkloads.workload.delete permission, the user should also have orgpolicy.policy.set permission on the deleted folder to remove Assured Workloads OrgPolicies.

Parameters
Name Description
request DeleteWorkloadRequest

The request to send to the server.

headers Metadata

The initial metadata to send with the call. This parameter is optional.

deadline DateTime

An optional deadline for the call. The call will be cancelled if deadline is hit.

cancellationToken CancellationToken

An optional token for canceling the call.

Returns
Type Description
AsyncUnaryCallEmpty

The call object.

GetWorkload(GetWorkloadRequest, CallOptions)

public virtual Workload GetWorkload(GetWorkloadRequest request, CallOptions options)

Gets Assured Workload associated with a CRM Node

Parameters
Name Description
request GetWorkloadRequest

The request to send to the server.

options CallOptions

The options for the call.

Returns
Type Description
Workload

The response received from the server.

GetWorkload(GetWorkloadRequest, Metadata, DateTime?, CancellationToken)

public virtual Workload GetWorkload(GetWorkloadRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

Gets Assured Workload associated with a CRM Node

Parameters
Name Description
request GetWorkloadRequest

The request to send to the server.

headers Metadata

The initial metadata to send with the call. This parameter is optional.

deadline DateTime

An optional deadline for the call. The call will be cancelled if deadline is hit.

cancellationToken CancellationToken

An optional token for canceling the call.

Returns
Type Description
Workload

The response received from the server.

GetWorkloadAsync(GetWorkloadRequest, CallOptions)

public virtual AsyncUnaryCall<Workload> GetWorkloadAsync(GetWorkloadRequest request, CallOptions options)

Gets Assured Workload associated with a CRM Node

Parameters
Name Description
request GetWorkloadRequest

The request to send to the server.

options CallOptions

The options for the call.

Returns
Type Description
AsyncUnaryCallWorkload

The call object.

GetWorkloadAsync(GetWorkloadRequest, Metadata, DateTime?, CancellationToken)

public virtual AsyncUnaryCall<Workload> GetWorkloadAsync(GetWorkloadRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

Gets Assured Workload associated with a CRM Node

Parameters
Name Description
request GetWorkloadRequest

The request to send to the server.

headers Metadata

The initial metadata to send with the call. This parameter is optional.

deadline DateTime

An optional deadline for the call. The call will be cancelled if deadline is hit.

cancellationToken CancellationToken

An optional token for canceling the call.

Returns
Type Description
AsyncUnaryCallWorkload

The call object.

ListWorkloads(ListWorkloadsRequest, CallOptions)

public virtual ListWorkloadsResponse ListWorkloads(ListWorkloadsRequest request, CallOptions options)

Lists Assured Workloads under a CRM Node.

Parameters
Name Description
request ListWorkloadsRequest

The request to send to the server.

options CallOptions

The options for the call.

Returns
Type Description
ListWorkloadsResponse

The response received from the server.

ListWorkloads(ListWorkloadsRequest, Metadata, DateTime?, CancellationToken)

public virtual ListWorkloadsResponse ListWorkloads(ListWorkloadsRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

Lists Assured Workloads under a CRM Node.

Parameters
Name Description
request ListWorkloadsRequest

The request to send to the server.

headers Metadata

The initial metadata to send with the call. This parameter is optional.

deadline DateTime

An optional deadline for the call. The call will be cancelled if deadline is hit.

cancellationToken CancellationToken

An optional token for canceling the call.

Returns
Type Description
ListWorkloadsResponse

The response received from the server.

ListWorkloadsAsync(ListWorkloadsRequest, CallOptions)

public virtual AsyncUnaryCall<ListWorkloadsResponse> ListWorkloadsAsync(ListWorkloadsRequest request, CallOptions options)

Lists Assured Workloads under a CRM Node.

Parameters
Name Description
request ListWorkloadsRequest

The request to send to the server.

options CallOptions

The options for the call.

Returns
Type Description
AsyncUnaryCallListWorkloadsResponse

The call object.

ListWorkloadsAsync(ListWorkloadsRequest, Metadata, DateTime?, CancellationToken)

public virtual AsyncUnaryCall<ListWorkloadsResponse> ListWorkloadsAsync(ListWorkloadsRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

Lists Assured Workloads under a CRM Node.

Parameters
Name Description
request ListWorkloadsRequest

The request to send to the server.

headers Metadata

The initial metadata to send with the call. This parameter is optional.

deadline DateTime

An optional deadline for the call. The call will be cancelled if deadline is hit.

cancellationToken CancellationToken

An optional token for canceling the call.

Returns
Type Description
AsyncUnaryCallListWorkloadsResponse

The call object.

NewInstance(ClientBaseConfiguration)

protected override AssuredWorkloadsService.AssuredWorkloadsServiceClient NewInstance(ClientBase.ClientBaseConfiguration configuration)

Creates a new instance of client from given ClientBaseConfiguration.

Parameter
Name Description
configuration ClientBaseClientBaseConfiguration
Returns
Type Description
AssuredWorkloadsServiceAssuredWorkloadsServiceClient
Overrides

RestrictAllowedResources(RestrictAllowedResourcesRequest, CallOptions)

public virtual RestrictAllowedResourcesResponse RestrictAllowedResources(RestrictAllowedResourcesRequest request, CallOptions options)

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 to send to the server.

options CallOptions

The options for the call.

Returns
Type Description
RestrictAllowedResourcesResponse

The response received from the server.

RestrictAllowedResources(RestrictAllowedResourcesRequest, Metadata, DateTime?, CancellationToken)

public virtual RestrictAllowedResourcesResponse RestrictAllowedResources(RestrictAllowedResourcesRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

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 to send to the server.

headers Metadata

The initial metadata to send with the call. This parameter is optional.

deadline DateTime

An optional deadline for the call. The call will be cancelled if deadline is hit.

cancellationToken CancellationToken

An optional token for canceling the call.

Returns
Type Description
RestrictAllowedResourcesResponse

The response received from the server.

RestrictAllowedResourcesAsync(RestrictAllowedResourcesRequest, CallOptions)

public virtual AsyncUnaryCall<RestrictAllowedResourcesResponse> RestrictAllowedResourcesAsync(RestrictAllowedResourcesRequest request, CallOptions options)

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 to send to the server.

options CallOptions

The options for the call.

Returns
Type Description
AsyncUnaryCallRestrictAllowedResourcesResponse

The call object.

RestrictAllowedResourcesAsync(RestrictAllowedResourcesRequest, Metadata, DateTime?, CancellationToken)

public virtual AsyncUnaryCall<RestrictAllowedResourcesResponse> RestrictAllowedResourcesAsync(RestrictAllowedResourcesRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

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 to send to the server.

headers Metadata

The initial metadata to send with the call. This parameter is optional.

deadline DateTime

An optional deadline for the call. The call will be cancelled if deadline is hit.

cancellationToken CancellationToken

An optional token for canceling the call.

Returns
Type Description
AsyncUnaryCallRestrictAllowedResourcesResponse

The call object.

UpdateWorkload(UpdateWorkloadRequest, CallOptions)

public virtual Workload UpdateWorkload(UpdateWorkloadRequest request, CallOptions options)

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 to send to the server.

options CallOptions

The options for the call.

Returns
Type Description
Workload

The response received from the server.

UpdateWorkload(UpdateWorkloadRequest, Metadata, DateTime?, CancellationToken)

public virtual Workload UpdateWorkload(UpdateWorkloadRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

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 to send to the server.

headers Metadata

The initial metadata to send with the call. This parameter is optional.

deadline DateTime

An optional deadline for the call. The call will be cancelled if deadline is hit.

cancellationToken CancellationToken

An optional token for canceling the call.

Returns
Type Description
Workload

The response received from the server.

UpdateWorkloadAsync(UpdateWorkloadRequest, CallOptions)

public virtual AsyncUnaryCall<Workload> UpdateWorkloadAsync(UpdateWorkloadRequest request, CallOptions options)

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 to send to the server.

options CallOptions

The options for the call.

Returns
Type Description
AsyncUnaryCallWorkload

The call object.

UpdateWorkloadAsync(UpdateWorkloadRequest, Metadata, DateTime?, CancellationToken)

public virtual AsyncUnaryCall<Workload> UpdateWorkloadAsync(UpdateWorkloadRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

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 to send to the server.

headers Metadata

The initial metadata to send with the call. This parameter is optional.

deadline DateTime

An optional deadline for the call. The call will be cancelled if deadline is hit.

cancellationToken CancellationToken

An optional token for canceling the call.

Returns
Type Description
AsyncUnaryCallWorkload

The call object.