Cloud Security Compliance v1 API - Class CmEnrollmentService.CmEnrollmentServiceClient (1.0.0-beta04)

public class CmEnrollmentService.CmEnrollmentServiceClient : ClientBase<CmEnrollmentService.CmEnrollmentServiceClient>

Reference documentation and code samples for the Cloud Security Compliance v1 API class CmEnrollmentService.CmEnrollmentServiceClient.

Client for CmEnrollmentService

Inheritance

object > ClientBase > ClientBaseCmEnrollmentServiceCmEnrollmentServiceClient > CmEnrollmentService.CmEnrollmentServiceClient

Namespace

Google.Cloud.CloudSecurityCompliance.V1

Assembly

Google.Cloud.CloudSecurityCompliance.V1.dll

Constructors

CmEnrollmentServiceClient()

protected CmEnrollmentServiceClient()

Protected parameterless constructor to allow creation of test doubles.

CmEnrollmentServiceClient(CallInvoker)

public CmEnrollmentServiceClient(CallInvoker callInvoker)

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

Parameter
Name Description
callInvoker CallInvoker

The callInvoker to use to make remote calls.

CmEnrollmentServiceClient(ChannelBase)

public CmEnrollmentServiceClient(ChannelBase channel)

Creates a new client for CmEnrollmentService

Parameter
Name Description
channel ChannelBase

The channel to use to make remote calls.

CmEnrollmentServiceClient(ClientBaseConfiguration)

protected CmEnrollmentServiceClient(ClientBase.ClientBaseConfiguration configuration)

Protected constructor to allow creation of configured clients.

Parameter
Name Description
configuration ClientBaseClientBaseConfiguration

The client configuration.

Methods

CalculateEffectiveCmEnrollment(CalculateEffectiveCmEnrollmentRequest, CallOptions)

public virtual CalculateEffectiveCmEnrollmentResponse CalculateEffectiveCmEnrollment(CalculateEffectiveCmEnrollmentRequest request, CallOptions options)

Calculates the effective Compliance Manager enrollment for a resource. An effective enrollment is either a direct enrollment of a resource (if it exists), or an enrollment of the closest parent of a resource that's enrolled in Compliance Manager.

Parameters
Name Description
request CalculateEffectiveCmEnrollmentRequest

The request to send to the server.

options CallOptions

The options for the call.

Returns
Type Description
CalculateEffectiveCmEnrollmentResponse

The response received from the server.

CalculateEffectiveCmEnrollment(CalculateEffectiveCmEnrollmentRequest, Metadata, DateTime?, CancellationToken)

public virtual CalculateEffectiveCmEnrollmentResponse CalculateEffectiveCmEnrollment(CalculateEffectiveCmEnrollmentRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

Calculates the effective Compliance Manager enrollment for a resource. An effective enrollment is either a direct enrollment of a resource (if it exists), or an enrollment of the closest parent of a resource that's enrolled in Compliance Manager.

Parameters
Name Description
request CalculateEffectiveCmEnrollmentRequest

The request to send to the server.

headers Metadata

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

deadline System.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
CalculateEffectiveCmEnrollmentResponse

The response received from the server.

CalculateEffectiveCmEnrollmentAsync(CalculateEffectiveCmEnrollmentRequest, CallOptions)

public virtual AsyncUnaryCall<CalculateEffectiveCmEnrollmentResponse> CalculateEffectiveCmEnrollmentAsync(CalculateEffectiveCmEnrollmentRequest request, CallOptions options)

Calculates the effective Compliance Manager enrollment for a resource. An effective enrollment is either a direct enrollment of a resource (if it exists), or an enrollment of the closest parent of a resource that's enrolled in Compliance Manager.

Parameters
Name Description
request CalculateEffectiveCmEnrollmentRequest

The request to send to the server.

options CallOptions

The options for the call.

Returns
Type Description
AsyncUnaryCallCalculateEffectiveCmEnrollmentResponse

The call object.

CalculateEffectiveCmEnrollmentAsync(CalculateEffectiveCmEnrollmentRequest, Metadata, DateTime?, CancellationToken)

public virtual AsyncUnaryCall<CalculateEffectiveCmEnrollmentResponse> CalculateEffectiveCmEnrollmentAsync(CalculateEffectiveCmEnrollmentRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

Calculates the effective Compliance Manager enrollment for a resource. An effective enrollment is either a direct enrollment of a resource (if it exists), or an enrollment of the closest parent of a resource that's enrolled in Compliance Manager.

Parameters
Name Description
request CalculateEffectiveCmEnrollmentRequest

The request to send to the server.

headers Metadata

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

deadline System.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
AsyncUnaryCallCalculateEffectiveCmEnrollmentResponse

The call object.

CreateLocationsClient()

public virtual Locations.LocationsClient CreateLocationsClient()

Creates a new instance of Locations.LocationsClient using the same call invoker as this client.

Returns
Type Description
LocationsLocationsClient

A new Locations.LocationsClient for the same target as this client.

NewInstance(ClientBaseConfiguration)

protected override CmEnrollmentService.CmEnrollmentServiceClient NewInstance(ClientBase.ClientBaseConfiguration configuration)

Creates a new instance of client from given ClientBaseConfiguration.

Parameter
Name Description
configuration ClientBaseClientBaseConfiguration
Returns
Type Description
CmEnrollmentServiceCmEnrollmentServiceClient
Overrides
Grpc.Core.ClientBase<Google.Cloud.CloudSecurityCompliance.V1.CmEnrollmentService.CmEnrollmentServiceClient>.NewInstance(Grpc.Core.ClientBase.ClientBaseConfiguration)

UpdateCmEnrollment(UpdateCmEnrollmentRequest, CallOptions)

public virtual CmEnrollment UpdateCmEnrollment(UpdateCmEnrollmentRequest request, CallOptions options)

Updates the Compliance Manager enrollment for a resource to facilitate an audit. Use this method to enroll a resource in Compliance Manager or to create or update feature-specific configurations.

Parameters
Name Description
request UpdateCmEnrollmentRequest

The request to send to the server.

options CallOptions

The options for the call.

Returns
Type Description
CmEnrollment

The response received from the server.

UpdateCmEnrollment(UpdateCmEnrollmentRequest, Metadata, DateTime?, CancellationToken)

public virtual CmEnrollment UpdateCmEnrollment(UpdateCmEnrollmentRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

Updates the Compliance Manager enrollment for a resource to facilitate an audit. Use this method to enroll a resource in Compliance Manager or to create or update feature-specific configurations.

Parameters
Name Description
request UpdateCmEnrollmentRequest

The request to send to the server.

headers Metadata

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

deadline System.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
CmEnrollment

The response received from the server.

UpdateCmEnrollmentAsync(UpdateCmEnrollmentRequest, CallOptions)

public virtual AsyncUnaryCall<CmEnrollment> UpdateCmEnrollmentAsync(UpdateCmEnrollmentRequest request, CallOptions options)

Updates the Compliance Manager enrollment for a resource to facilitate an audit. Use this method to enroll a resource in Compliance Manager or to create or update feature-specific configurations.

Parameters
Name Description
request UpdateCmEnrollmentRequest

The request to send to the server.

options CallOptions

The options for the call.

Returns
Type Description
AsyncUnaryCallCmEnrollment

The call object.

UpdateCmEnrollmentAsync(UpdateCmEnrollmentRequest, Metadata, DateTime?, CancellationToken)

public virtual AsyncUnaryCall<CmEnrollment> UpdateCmEnrollmentAsync(UpdateCmEnrollmentRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

Updates the Compliance Manager enrollment for a resource to facilitate an audit. Use this method to enroll a resource in Compliance Manager or to create or update feature-specific configurations.

Parameters
Name Description
request UpdateCmEnrollmentRequest

The request to send to the server.

headers Metadata

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

deadline System.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
AsyncUnaryCallCmEnrollment

The call object.