Cloud Controls Partner v1 API - Class CloudControlsPartnerCore.CloudControlsPartnerCoreClient (1.0.0-beta02)

public class CloudControlsPartnerCore.CloudControlsPartnerCoreClient : ClientBase<CloudControlsPartnerCore.CloudControlsPartnerCoreClient>

Reference documentation and code samples for the Cloud Controls Partner v1 API class CloudControlsPartnerCore.CloudControlsPartnerCoreClient.

Client for CloudControlsPartnerCore

Inheritance

object > ClientBase > ClientBaseCloudControlsPartnerCoreCloudControlsPartnerCoreClient > CloudControlsPartnerCore.CloudControlsPartnerCoreClient

Namespace

Google.Cloud.CloudControlsPartner.V1

Assembly

Google.Cloud.CloudControlsPartner.V1.dll

Constructors

CloudControlsPartnerCoreClient()

protected CloudControlsPartnerCoreClient()

Protected parameterless constructor to allow creation of test doubles.

CloudControlsPartnerCoreClient(CallInvoker)

public CloudControlsPartnerCoreClient(CallInvoker callInvoker)

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

Parameter
Name Description
callInvoker CallInvoker

The callInvoker to use to make remote calls.

CloudControlsPartnerCoreClient(ChannelBase)

public CloudControlsPartnerCoreClient(ChannelBase channel)

Creates a new client for CloudControlsPartnerCore

Parameter
Name Description
channel ChannelBase

The channel to use to make remote calls.

CloudControlsPartnerCoreClient(ClientBaseConfiguration)

protected CloudControlsPartnerCoreClient(ClientBase.ClientBaseConfiguration configuration)

Protected constructor to allow creation of configured clients.

Parameter
Name Description
configuration ClientBaseClientBaseConfiguration

The client configuration.

Methods

GetCustomer(GetCustomerRequest, CallOptions)

public virtual Customer GetCustomer(GetCustomerRequest request, CallOptions options)

Gets details of a single customer

Parameters
Name Description
request GetCustomerRequest

The request to send to the server.

options CallOptions

The options for the call.

Returns
Type Description
Customer

The response received from the server.

GetCustomer(GetCustomerRequest, Metadata, DateTime?, CancellationToken)

public virtual Customer GetCustomer(GetCustomerRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

Gets details of a single customer

Parameters
Name Description
request GetCustomerRequest

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
Customer

The response received from the server.

GetCustomerAsync(GetCustomerRequest, CallOptions)

public virtual AsyncUnaryCall<Customer> GetCustomerAsync(GetCustomerRequest request, CallOptions options)

Gets details of a single customer

Parameters
Name Description
request GetCustomerRequest

The request to send to the server.

options CallOptions

The options for the call.

Returns
Type Description
AsyncUnaryCallCustomer

The call object.

GetCustomerAsync(GetCustomerRequest, Metadata, DateTime?, CancellationToken)

public virtual AsyncUnaryCall<Customer> GetCustomerAsync(GetCustomerRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

Gets details of a single customer

Parameters
Name Description
request GetCustomerRequest

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
AsyncUnaryCallCustomer

The call object.

GetEkmConnections(GetEkmConnectionsRequest, CallOptions)

public virtual EkmConnections GetEkmConnections(GetEkmConnectionsRequest request, CallOptions options)

Gets the EKM connections associated with a workload

Parameters
Name Description
request GetEkmConnectionsRequest

The request to send to the server.

options CallOptions

The options for the call.

Returns
Type Description
EkmConnections

The response received from the server.

GetEkmConnections(GetEkmConnectionsRequest, Metadata, DateTime?, CancellationToken)

public virtual EkmConnections GetEkmConnections(GetEkmConnectionsRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

Gets the EKM connections associated with a workload

Parameters
Name Description
request GetEkmConnectionsRequest

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
EkmConnections

The response received from the server.

GetEkmConnectionsAsync(GetEkmConnectionsRequest, CallOptions)

public virtual AsyncUnaryCall<EkmConnections> GetEkmConnectionsAsync(GetEkmConnectionsRequest request, CallOptions options)

Gets the EKM connections associated with a workload

Parameters
Name Description
request GetEkmConnectionsRequest

The request to send to the server.

options CallOptions

The options for the call.

Returns
Type Description
AsyncUnaryCallEkmConnections

The call object.

GetEkmConnectionsAsync(GetEkmConnectionsRequest, Metadata, DateTime?, CancellationToken)

public virtual AsyncUnaryCall<EkmConnections> GetEkmConnectionsAsync(GetEkmConnectionsRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

Gets the EKM connections associated with a workload

Parameters
Name Description
request GetEkmConnectionsRequest

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
AsyncUnaryCallEkmConnections

The call object.

GetPartner(GetPartnerRequest, CallOptions)

public virtual Partner GetPartner(GetPartnerRequest request, CallOptions options)

Get details of a Partner.

Parameters
Name Description
request GetPartnerRequest

The request to send to the server.

options CallOptions

The options for the call.

Returns
Type Description
Partner

The response received from the server.

GetPartner(GetPartnerRequest, Metadata, DateTime?, CancellationToken)

public virtual Partner GetPartner(GetPartnerRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

Get details of a Partner.

Parameters
Name Description
request GetPartnerRequest

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
Partner

The response received from the server.

GetPartnerAsync(GetPartnerRequest, CallOptions)

public virtual AsyncUnaryCall<Partner> GetPartnerAsync(GetPartnerRequest request, CallOptions options)

Get details of a Partner.

Parameters
Name Description
request GetPartnerRequest

The request to send to the server.

options CallOptions

The options for the call.

Returns
Type Description
AsyncUnaryCallPartner

The call object.

GetPartnerAsync(GetPartnerRequest, Metadata, DateTime?, CancellationToken)

public virtual AsyncUnaryCall<Partner> GetPartnerAsync(GetPartnerRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

Get details of a Partner.

Parameters
Name Description
request GetPartnerRequest

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
AsyncUnaryCallPartner

The call object.

GetPartnerPermissions(GetPartnerPermissionsRequest, CallOptions)

public virtual PartnerPermissions GetPartnerPermissions(GetPartnerPermissionsRequest request, CallOptions options)

Gets the partner permissions granted for a workload

Parameters
Name Description
request GetPartnerPermissionsRequest

The request to send to the server.

options CallOptions

The options for the call.

Returns
Type Description
PartnerPermissions

The response received from the server.

GetPartnerPermissions(GetPartnerPermissionsRequest, Metadata, DateTime?, CancellationToken)

public virtual PartnerPermissions GetPartnerPermissions(GetPartnerPermissionsRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

Gets the partner permissions granted for a workload

Parameters
Name Description
request GetPartnerPermissionsRequest

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
PartnerPermissions

The response received from the server.

GetPartnerPermissionsAsync(GetPartnerPermissionsRequest, CallOptions)

public virtual AsyncUnaryCall<PartnerPermissions> GetPartnerPermissionsAsync(GetPartnerPermissionsRequest request, CallOptions options)

Gets the partner permissions granted for a workload

Parameters
Name Description
request GetPartnerPermissionsRequest

The request to send to the server.

options CallOptions

The options for the call.

Returns
Type Description
AsyncUnaryCallPartnerPermissions

The call object.

GetPartnerPermissionsAsync(GetPartnerPermissionsRequest, Metadata, DateTime?, CancellationToken)

public virtual AsyncUnaryCall<PartnerPermissions> GetPartnerPermissionsAsync(GetPartnerPermissionsRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

Gets the partner permissions granted for a workload

Parameters
Name Description
request GetPartnerPermissionsRequest

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
AsyncUnaryCallPartnerPermissions

The call object.

GetWorkload(GetWorkloadRequest, CallOptions)

public virtual Workload GetWorkload(GetWorkloadRequest request, CallOptions options)

Gets details of a single workload

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 details of a single workload

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 details of a single workload

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 details of a single workload

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.

ListAccessApprovalRequests(ListAccessApprovalRequestsRequest, CallOptions)

public virtual ListAccessApprovalRequestsResponse ListAccessApprovalRequests(ListAccessApprovalRequestsRequest request, CallOptions options)

Lists access requests associated with a workload

Parameters
Name Description
request ListAccessApprovalRequestsRequest

The request to send to the server.

options CallOptions

The options for the call.

Returns
Type Description
ListAccessApprovalRequestsResponse

The response received from the server.

ListAccessApprovalRequests(ListAccessApprovalRequestsRequest, Metadata, DateTime?, CancellationToken)

public virtual ListAccessApprovalRequestsResponse ListAccessApprovalRequests(ListAccessApprovalRequestsRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

Lists access requests associated with a workload

Parameters
Name Description
request ListAccessApprovalRequestsRequest

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
ListAccessApprovalRequestsResponse

The response received from the server.

ListAccessApprovalRequestsAsync(ListAccessApprovalRequestsRequest, CallOptions)

public virtual AsyncUnaryCall<ListAccessApprovalRequestsResponse> ListAccessApprovalRequestsAsync(ListAccessApprovalRequestsRequest request, CallOptions options)

Lists access requests associated with a workload

Parameters
Name Description
request ListAccessApprovalRequestsRequest

The request to send to the server.

options CallOptions

The options for the call.

Returns
Type Description
AsyncUnaryCallListAccessApprovalRequestsResponse

The call object.

ListAccessApprovalRequestsAsync(ListAccessApprovalRequestsRequest, Metadata, DateTime?, CancellationToken)

public virtual AsyncUnaryCall<ListAccessApprovalRequestsResponse> ListAccessApprovalRequestsAsync(ListAccessApprovalRequestsRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

Lists access requests associated with a workload

Parameters
Name Description
request ListAccessApprovalRequestsRequest

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
AsyncUnaryCallListAccessApprovalRequestsResponse

The call object.

ListCustomers(ListCustomersRequest, CallOptions)

public virtual ListCustomersResponse ListCustomers(ListCustomersRequest request, CallOptions options)

Lists customers of a partner identified by its Google Cloud organization ID

Parameters
Name Description
request ListCustomersRequest

The request to send to the server.

options CallOptions

The options for the call.

Returns
Type Description
ListCustomersResponse

The response received from the server.

ListCustomers(ListCustomersRequest, Metadata, DateTime?, CancellationToken)

public virtual ListCustomersResponse ListCustomers(ListCustomersRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

Lists customers of a partner identified by its Google Cloud organization ID

Parameters
Name Description
request ListCustomersRequest

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
ListCustomersResponse

The response received from the server.

ListCustomersAsync(ListCustomersRequest, CallOptions)

public virtual AsyncUnaryCall<ListCustomersResponse> ListCustomersAsync(ListCustomersRequest request, CallOptions options)

Lists customers of a partner identified by its Google Cloud organization ID

Parameters
Name Description
request ListCustomersRequest

The request to send to the server.

options CallOptions

The options for the call.

Returns
Type Description
AsyncUnaryCallListCustomersResponse

The call object.

ListCustomersAsync(ListCustomersRequest, Metadata, DateTime?, CancellationToken)

public virtual AsyncUnaryCall<ListCustomersResponse> ListCustomersAsync(ListCustomersRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

Lists customers of a partner identified by its Google Cloud organization ID

Parameters
Name Description
request ListCustomersRequest

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
AsyncUnaryCallListCustomersResponse

The call object.

ListWorkloads(ListWorkloadsRequest, CallOptions)

public virtual ListWorkloadsResponse ListWorkloads(ListWorkloadsRequest request, CallOptions options)

Lists customer workloads for a given customer org id

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 customer workloads for a given customer org id

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 customer workloads for a given customer org id

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 customer workloads for a given customer org id

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 CloudControlsPartnerCore.CloudControlsPartnerCoreClient NewInstance(ClientBase.ClientBaseConfiguration configuration)

Creates a new instance of client from given ClientBaseConfiguration.

Parameter
Name Description
configuration ClientBaseClientBaseConfiguration
Returns
Type Description
CloudControlsPartnerCoreCloudControlsPartnerCoreClient
Overrides