Cloud Controls Partner v1beta API - Class CloudControlsPartnerCoreClient (1.0.0-beta03)

public abstract class CloudControlsPartnerCoreClient

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

CloudControlsPartnerCore client wrapper, for convenient use.

Inheritance

object > CloudControlsPartnerCoreClient

Namespace

Google.Cloud.CloudControlsPartner.V1Beta

Assembly

Google.Cloud.CloudControlsPartner.V1Beta.dll

Remarks

Service describing handlers for resources

Properties

DefaultEndpoint

public static string DefaultEndpoint { get; }

The default endpoint for the CloudControlsPartnerCore service, which is a host of "cloudcontrolspartner.googleapis.com" and a port of 443.

Property Value
Type Description
string

DefaultScopes

public static IReadOnlyList<string> DefaultScopes { get; }

The default CloudControlsPartnerCore scopes.

Property Value
Type Description
IReadOnlyListstring
Remarks

The default CloudControlsPartnerCore scopes are:

GrpcClient

public virtual CloudControlsPartnerCore.CloudControlsPartnerCoreClient GrpcClient { get; }

The underlying gRPC CloudControlsPartnerCore client

Property Value
Type Description
CloudControlsPartnerCoreCloudControlsPartnerCoreClient

ServiceMetadata

public static ServiceMetadata ServiceMetadata { get; }

The service metadata associated with this client type.

Property Value
Type Description
ServiceMetadata

Methods

Create()

public static CloudControlsPartnerCoreClient Create()

Synchronously creates a CloudControlsPartnerCoreClient using the default credentials, endpoint and settings. To specify custom credentials or other settings, use CloudControlsPartnerCoreClientBuilder.

Returns
Type Description
CloudControlsPartnerCoreClient

The created CloudControlsPartnerCoreClient.

CreateAsync(CancellationToken)

public static Task<CloudControlsPartnerCoreClient> CreateAsync(CancellationToken cancellationToken = default)

Asynchronously creates a CloudControlsPartnerCoreClient using the default credentials, endpoint and settings. To specify custom credentials or other settings, use CloudControlsPartnerCoreClientBuilder.

Parameter
Name Description
cancellationToken CancellationToken

The CancellationToken to use while creating the client.

Returns
Type Description
TaskCloudControlsPartnerCoreClient

The task representing the created CloudControlsPartnerCoreClient.

GetCustomer(CustomerName, CallSettings)

public virtual Customer GetCustomer(CustomerName name, CallSettings callSettings = null)

Gets details of a single customer

Parameters
Name Description
name CustomerName

Required. Format: organizations/{organization}/locations/{location}/customers/{customer}

callSettings CallSettings

If not null, applies overrides to this RPC call.

Returns
Type Description
Customer

The RPC response.

Example
// Create client
CloudControlsPartnerCoreClient cloudControlsPartnerCoreClient = CloudControlsPartnerCoreClient.Create();
// Initialize request argument(s)
CustomerName name = CustomerName.FromOrganizationLocationCustomer("[ORGANIZATION]", "[LOCATION]", "[CUSTOMER]");
// Make the request
Customer response = cloudControlsPartnerCoreClient.GetCustomer(name);

GetCustomer(GetCustomerRequest, CallSettings)

public virtual Customer GetCustomer(GetCustomerRequest request, CallSettings callSettings = null)

Gets details of a single customer

Parameters
Name Description
request GetCustomerRequest

The request object containing all of the parameters for the API call.

callSettings CallSettings

If not null, applies overrides to this RPC call.

Returns
Type Description
Customer

The RPC response.

Example
// Create client
CloudControlsPartnerCoreClient cloudControlsPartnerCoreClient = CloudControlsPartnerCoreClient.Create();
// Initialize request argument(s)
GetCustomerRequest request = new GetCustomerRequest
{
    CustomerName = CustomerName.FromOrganizationLocationCustomer("[ORGANIZATION]", "[LOCATION]", "[CUSTOMER]"),
};
// Make the request
Customer response = cloudControlsPartnerCoreClient.GetCustomer(request);

GetCustomer(string, CallSettings)

public virtual Customer GetCustomer(string name, CallSettings callSettings = null)

Gets details of a single customer

Parameters
Name Description
name string

Required. Format: organizations/{organization}/locations/{location}/customers/{customer}

callSettings CallSettings

If not null, applies overrides to this RPC call.

Returns
Type Description
Customer

The RPC response.

Example
// Create client
CloudControlsPartnerCoreClient cloudControlsPartnerCoreClient = CloudControlsPartnerCoreClient.Create();
// Initialize request argument(s)
string name = "organizations/[ORGANIZATION]/locations/[LOCATION]/customers/[CUSTOMER]";
// Make the request
Customer response = cloudControlsPartnerCoreClient.GetCustomer(name);

GetCustomerAsync(CustomerName, CallSettings)

public virtual Task<Customer> GetCustomerAsync(CustomerName name, CallSettings callSettings = null)

Gets details of a single customer

Parameters
Name Description
name CustomerName

Required. Format: organizations/{organization}/locations/{location}/customers/{customer}

callSettings CallSettings

If not null, applies overrides to this RPC call.

Returns
Type Description
TaskCustomer

A Task containing the RPC response.

Example
// Create client
CloudControlsPartnerCoreClient cloudControlsPartnerCoreClient = await CloudControlsPartnerCoreClient.CreateAsync();
// Initialize request argument(s)
CustomerName name = CustomerName.FromOrganizationLocationCustomer("[ORGANIZATION]", "[LOCATION]", "[CUSTOMER]");
// Make the request
Customer response = await cloudControlsPartnerCoreClient.GetCustomerAsync(name);

GetCustomerAsync(CustomerName, CancellationToken)

public virtual Task<Customer> GetCustomerAsync(CustomerName name, CancellationToken cancellationToken)

Gets details of a single customer

Parameters
Name Description
name CustomerName

Required. Format: organizations/{organization}/locations/{location}/customers/{customer}

cancellationToken CancellationToken

A CancellationToken to use for this RPC.

Returns
Type Description
TaskCustomer

A Task containing the RPC response.

Example
// Create client
CloudControlsPartnerCoreClient cloudControlsPartnerCoreClient = await CloudControlsPartnerCoreClient.CreateAsync();
// Initialize request argument(s)
CustomerName name = CustomerName.FromOrganizationLocationCustomer("[ORGANIZATION]", "[LOCATION]", "[CUSTOMER]");
// Make the request
Customer response = await cloudControlsPartnerCoreClient.GetCustomerAsync(name);

GetCustomerAsync(GetCustomerRequest, CallSettings)

public virtual Task<Customer> GetCustomerAsync(GetCustomerRequest request, CallSettings callSettings = null)

Gets details of a single customer

Parameters
Name Description
request GetCustomerRequest

The request object containing all of the parameters for the API call.

callSettings CallSettings

If not null, applies overrides to this RPC call.

Returns
Type Description
TaskCustomer

A Task containing the RPC response.

Example
// Create client
CloudControlsPartnerCoreClient cloudControlsPartnerCoreClient = await CloudControlsPartnerCoreClient.CreateAsync();
// Initialize request argument(s)
GetCustomerRequest request = new GetCustomerRequest
{
    CustomerName = CustomerName.FromOrganizationLocationCustomer("[ORGANIZATION]", "[LOCATION]", "[CUSTOMER]"),
};
// Make the request
Customer response = await cloudControlsPartnerCoreClient.GetCustomerAsync(request);

GetCustomerAsync(GetCustomerRequest, CancellationToken)

public virtual Task<Customer> GetCustomerAsync(GetCustomerRequest request, CancellationToken cancellationToken)

Gets details of a single customer

Parameters
Name Description
request GetCustomerRequest

The request object containing all of the parameters for the API call.

cancellationToken CancellationToken

A CancellationToken to use for this RPC.

Returns
Type Description
TaskCustomer

A Task containing the RPC response.

Example
// Create client
CloudControlsPartnerCoreClient cloudControlsPartnerCoreClient = await CloudControlsPartnerCoreClient.CreateAsync();
// Initialize request argument(s)
GetCustomerRequest request = new GetCustomerRequest
{
    CustomerName = CustomerName.FromOrganizationLocationCustomer("[ORGANIZATION]", "[LOCATION]", "[CUSTOMER]"),
};
// Make the request
Customer response = await cloudControlsPartnerCoreClient.GetCustomerAsync(request);

GetCustomerAsync(string, CallSettings)

public virtual Task<Customer> GetCustomerAsync(string name, CallSettings callSettings = null)

Gets details of a single customer

Parameters
Name Description
name string

Required. Format: organizations/{organization}/locations/{location}/customers/{customer}

callSettings CallSettings

If not null, applies overrides to this RPC call.

Returns
Type Description
TaskCustomer

A Task containing the RPC response.

Example
// Create client
CloudControlsPartnerCoreClient cloudControlsPartnerCoreClient = await CloudControlsPartnerCoreClient.CreateAsync();
// Initialize request argument(s)
string name = "organizations/[ORGANIZATION]/locations/[LOCATION]/customers/[CUSTOMER]";
// Make the request
Customer response = await cloudControlsPartnerCoreClient.GetCustomerAsync(name);

GetCustomerAsync(string, CancellationToken)

public virtual Task<Customer> GetCustomerAsync(string name, CancellationToken cancellationToken)

Gets details of a single customer

Parameters
Name Description
name string

Required. Format: organizations/{organization}/locations/{location}/customers/{customer}

cancellationToken CancellationToken

A CancellationToken to use for this RPC.

Returns
Type Description
TaskCustomer

A Task containing the RPC response.

Example
// Create client
CloudControlsPartnerCoreClient cloudControlsPartnerCoreClient = await CloudControlsPartnerCoreClient.CreateAsync();
// Initialize request argument(s)
string name = "organizations/[ORGANIZATION]/locations/[LOCATION]/customers/[CUSTOMER]";
// Make the request
Customer response = await cloudControlsPartnerCoreClient.GetCustomerAsync(name);

GetEkmConnections(EkmConnectionsName, CallSettings)

public virtual EkmConnections GetEkmConnections(EkmConnectionsName name, CallSettings callSettings = null)

Gets the EKM connections associated with a workload

Parameters
Name Description
name EkmConnectionsName

Required. Format: organizations/{organization}/locations/{location}/customers/{customer}/workloads/{workload}/ekmConnections

callSettings CallSettings

If not null, applies overrides to this RPC call.

Returns
Type Description
EkmConnections

The RPC response.

Example
// Create client
CloudControlsPartnerCoreClient cloudControlsPartnerCoreClient = CloudControlsPartnerCoreClient.Create();
// Initialize request argument(s)
EkmConnectionsName name = EkmConnectionsName.FromOrganizationLocationCustomerWorkload("[ORGANIZATION]", "[LOCATION]", "[CUSTOMER]", "[WORKLOAD]");
// Make the request
EkmConnections response = cloudControlsPartnerCoreClient.GetEkmConnections(name);

GetEkmConnections(GetEkmConnectionsRequest, CallSettings)

public virtual EkmConnections GetEkmConnections(GetEkmConnectionsRequest request, CallSettings callSettings = null)

Gets the EKM connections associated with a workload

Parameters
Name Description
request GetEkmConnectionsRequest

The request object containing all of the parameters for the API call.

callSettings CallSettings

If not null, applies overrides to this RPC call.

Returns
Type Description
EkmConnections

The RPC response.

Example
// Create client
CloudControlsPartnerCoreClient cloudControlsPartnerCoreClient = CloudControlsPartnerCoreClient.Create();
// Initialize request argument(s)
GetEkmConnectionsRequest request = new GetEkmConnectionsRequest
{
    EkmConnectionsName = EkmConnectionsName.FromOrganizationLocationCustomerWorkload("[ORGANIZATION]", "[LOCATION]", "[CUSTOMER]", "[WORKLOAD]"),
};
// Make the request
EkmConnections response = cloudControlsPartnerCoreClient.GetEkmConnections(request);

GetEkmConnections(string, CallSettings)

public virtual EkmConnections GetEkmConnections(string name, CallSettings callSettings = null)

Gets the EKM connections associated with a workload

Parameters
Name Description
name string

Required. Format: organizations/{organization}/locations/{location}/customers/{customer}/workloads/{workload}/ekmConnections

callSettings CallSettings

If not null, applies overrides to this RPC call.

Returns
Type Description
EkmConnections

The RPC response.

Example
// Create client
CloudControlsPartnerCoreClient cloudControlsPartnerCoreClient = CloudControlsPartnerCoreClient.Create();
// Initialize request argument(s)
string name = "organizations/[ORGANIZATION]/locations/[LOCATION]/customers/[CUSTOMER]/workloads/[WORKLOAD]/ekmConnections";
// Make the request
EkmConnections response = cloudControlsPartnerCoreClient.GetEkmConnections(name);

GetEkmConnectionsAsync(EkmConnectionsName, CallSettings)

public virtual Task<EkmConnections> GetEkmConnectionsAsync(EkmConnectionsName name, CallSettings callSettings = null)

Gets the EKM connections associated with a workload

Parameters
Name Description
name EkmConnectionsName

Required. Format: organizations/{organization}/locations/{location}/customers/{customer}/workloads/{workload}/ekmConnections

callSettings CallSettings

If not null, applies overrides to this RPC call.

Returns
Type Description
TaskEkmConnections

A Task containing the RPC response.

Example
// Create client
CloudControlsPartnerCoreClient cloudControlsPartnerCoreClient = await CloudControlsPartnerCoreClient.CreateAsync();
// Initialize request argument(s)
EkmConnectionsName name = EkmConnectionsName.FromOrganizationLocationCustomerWorkload("[ORGANIZATION]", "[LOCATION]", "[CUSTOMER]", "[WORKLOAD]");
// Make the request
EkmConnections response = await cloudControlsPartnerCoreClient.GetEkmConnectionsAsync(name);

GetEkmConnectionsAsync(EkmConnectionsName, CancellationToken)

public virtual Task<EkmConnections> GetEkmConnectionsAsync(EkmConnectionsName name, CancellationToken cancellationToken)

Gets the EKM connections associated with a workload

Parameters
Name Description
name EkmConnectionsName

Required. Format: organizations/{organization}/locations/{location}/customers/{customer}/workloads/{workload}/ekmConnections

cancellationToken CancellationToken

A CancellationToken to use for this RPC.

Returns
Type Description
TaskEkmConnections

A Task containing the RPC response.

Example
// Create client
CloudControlsPartnerCoreClient cloudControlsPartnerCoreClient = await CloudControlsPartnerCoreClient.CreateAsync();
// Initialize request argument(s)
EkmConnectionsName name = EkmConnectionsName.FromOrganizationLocationCustomerWorkload("[ORGANIZATION]", "[LOCATION]", "[CUSTOMER]", "[WORKLOAD]");
// Make the request
EkmConnections response = await cloudControlsPartnerCoreClient.GetEkmConnectionsAsync(name);

GetEkmConnectionsAsync(GetEkmConnectionsRequest, CallSettings)

public virtual Task<EkmConnections> GetEkmConnectionsAsync(GetEkmConnectionsRequest request, CallSettings callSettings = null)

Gets the EKM connections associated with a workload

Parameters
Name Description
request GetEkmConnectionsRequest

The request object containing all of the parameters for the API call.

callSettings CallSettings

If not null, applies overrides to this RPC call.

Returns
Type Description
TaskEkmConnections

A Task containing the RPC response.

Example
// Create client
CloudControlsPartnerCoreClient cloudControlsPartnerCoreClient = await CloudControlsPartnerCoreClient.CreateAsync();
// Initialize request argument(s)
GetEkmConnectionsRequest request = new GetEkmConnectionsRequest
{
    EkmConnectionsName = EkmConnectionsName.FromOrganizationLocationCustomerWorkload("[ORGANIZATION]", "[LOCATION]", "[CUSTOMER]", "[WORKLOAD]"),
};
// Make the request
EkmConnections response = await cloudControlsPartnerCoreClient.GetEkmConnectionsAsync(request);

GetEkmConnectionsAsync(GetEkmConnectionsRequest, CancellationToken)

public virtual Task<EkmConnections> GetEkmConnectionsAsync(GetEkmConnectionsRequest request, CancellationToken cancellationToken)

Gets the EKM connections associated with a workload

Parameters
Name Description
request GetEkmConnectionsRequest

The request object containing all of the parameters for the API call.

cancellationToken CancellationToken

A CancellationToken to use for this RPC.

Returns
Type Description
TaskEkmConnections

A Task containing the RPC response.

Example
// Create client
CloudControlsPartnerCoreClient cloudControlsPartnerCoreClient = await CloudControlsPartnerCoreClient.CreateAsync();
// Initialize request argument(s)
GetEkmConnectionsRequest request = new GetEkmConnectionsRequest
{
    EkmConnectionsName = EkmConnectionsName.FromOrganizationLocationCustomerWorkload("[ORGANIZATION]", "[LOCATION]", "[CUSTOMER]", "[WORKLOAD]"),
};
// Make the request
EkmConnections response = await cloudControlsPartnerCoreClient.GetEkmConnectionsAsync(request);

GetEkmConnectionsAsync(string, CallSettings)

public virtual Task<EkmConnections> GetEkmConnectionsAsync(string name, CallSettings callSettings = null)

Gets the EKM connections associated with a workload

Parameters
Name Description
name string

Required. Format: organizations/{organization}/locations/{location}/customers/{customer}/workloads/{workload}/ekmConnections

callSettings CallSettings

If not null, applies overrides to this RPC call.

Returns
Type Description
TaskEkmConnections

A Task containing the RPC response.

Example
// Create client
CloudControlsPartnerCoreClient cloudControlsPartnerCoreClient = await CloudControlsPartnerCoreClient.CreateAsync();
// Initialize request argument(s)
string name = "organizations/[ORGANIZATION]/locations/[LOCATION]/customers/[CUSTOMER]/workloads/[WORKLOAD]/ekmConnections";
// Make the request
EkmConnections response = await cloudControlsPartnerCoreClient.GetEkmConnectionsAsync(name);

GetEkmConnectionsAsync(string, CancellationToken)

public virtual Task<EkmConnections> GetEkmConnectionsAsync(string name, CancellationToken cancellationToken)

Gets the EKM connections associated with a workload

Parameters
Name Description
name string

Required. Format: organizations/{organization}/locations/{location}/customers/{customer}/workloads/{workload}/ekmConnections

cancellationToken CancellationToken

A CancellationToken to use for this RPC.

Returns
Type Description
TaskEkmConnections

A Task containing the RPC response.

Example
// Create client
CloudControlsPartnerCoreClient cloudControlsPartnerCoreClient = await CloudControlsPartnerCoreClient.CreateAsync();
// Initialize request argument(s)
string name = "organizations/[ORGANIZATION]/locations/[LOCATION]/customers/[CUSTOMER]/workloads/[WORKLOAD]/ekmConnections";
// Make the request
EkmConnections response = await cloudControlsPartnerCoreClient.GetEkmConnectionsAsync(name);

GetPartner(GetPartnerRequest, CallSettings)

public virtual Partner GetPartner(GetPartnerRequest request, CallSettings callSettings = null)

Get details of a Partner.

Parameters
Name Description
request GetPartnerRequest

The request object containing all of the parameters for the API call.

callSettings CallSettings

If not null, applies overrides to this RPC call.

Returns
Type Description
Partner

The RPC response.

Example
// Create client
CloudControlsPartnerCoreClient cloudControlsPartnerCoreClient = CloudControlsPartnerCoreClient.Create();
// Initialize request argument(s)
GetPartnerRequest request = new GetPartnerRequest
{
    PartnerName = PartnerName.FromOrganizationLocation("[ORGANIZATION]", "[LOCATION]"),
};
// Make the request
Partner response = cloudControlsPartnerCoreClient.GetPartner(request);

GetPartner(PartnerName, CallSettings)

public virtual Partner GetPartner(PartnerName name, CallSettings callSettings = null)

Get details of a Partner.

Parameters
Name Description
name PartnerName

Required. Format: organizations/{organization}/locations/{location}/partner

callSettings CallSettings

If not null, applies overrides to this RPC call.

Returns
Type Description
Partner

The RPC response.

Example
// Create client
CloudControlsPartnerCoreClient cloudControlsPartnerCoreClient = CloudControlsPartnerCoreClient.Create();
// Initialize request argument(s)
PartnerName name = PartnerName.FromOrganizationLocation("[ORGANIZATION]", "[LOCATION]");
// Make the request
Partner response = cloudControlsPartnerCoreClient.GetPartner(name);

GetPartner(string, CallSettings)

public virtual Partner GetPartner(string name, CallSettings callSettings = null)

Get details of a Partner.

Parameters
Name Description
name string

Required. Format: organizations/{organization}/locations/{location}/partner

callSettings CallSettings

If not null, applies overrides to this RPC call.

Returns
Type Description
Partner

The RPC response.

Example
// Create client
CloudControlsPartnerCoreClient cloudControlsPartnerCoreClient = CloudControlsPartnerCoreClient.Create();
// Initialize request argument(s)
string name = "organizations/[ORGANIZATION]/locations/[LOCATION]/partner";
// Make the request
Partner response = cloudControlsPartnerCoreClient.GetPartner(name);

GetPartnerAsync(GetPartnerRequest, CallSettings)

public virtual Task<Partner> GetPartnerAsync(GetPartnerRequest request, CallSettings callSettings = null)

Get details of a Partner.

Parameters
Name Description
request GetPartnerRequest

The request object containing all of the parameters for the API call.

callSettings CallSettings

If not null, applies overrides to this RPC call.

Returns
Type Description
TaskPartner

A Task containing the RPC response.

Example
// Create client
CloudControlsPartnerCoreClient cloudControlsPartnerCoreClient = await CloudControlsPartnerCoreClient.CreateAsync();
// Initialize request argument(s)
GetPartnerRequest request = new GetPartnerRequest
{
    PartnerName = PartnerName.FromOrganizationLocation("[ORGANIZATION]", "[LOCATION]"),
};
// Make the request
Partner response = await cloudControlsPartnerCoreClient.GetPartnerAsync(request);

GetPartnerAsync(GetPartnerRequest, CancellationToken)

public virtual Task<Partner> GetPartnerAsync(GetPartnerRequest request, CancellationToken cancellationToken)

Get details of a Partner.

Parameters
Name Description
request GetPartnerRequest

The request object containing all of the parameters for the API call.

cancellationToken CancellationToken

A CancellationToken to use for this RPC.

Returns
Type Description
TaskPartner

A Task containing the RPC response.

Example
// Create client
CloudControlsPartnerCoreClient cloudControlsPartnerCoreClient = await CloudControlsPartnerCoreClient.CreateAsync();
// Initialize request argument(s)
GetPartnerRequest request = new GetPartnerRequest
{
    PartnerName = PartnerName.FromOrganizationLocation("[ORGANIZATION]", "[LOCATION]"),
};
// Make the request
Partner response = await cloudControlsPartnerCoreClient.GetPartnerAsync(request);

GetPartnerAsync(PartnerName, CallSettings)

public virtual Task<Partner> GetPartnerAsync(PartnerName name, CallSettings callSettings = null)

Get details of a Partner.

Parameters
Name Description
name PartnerName

Required. Format: organizations/{organization}/locations/{location}/partner

callSettings CallSettings

If not null, applies overrides to this RPC call.

Returns
Type Description
TaskPartner

A Task containing the RPC response.

Example
// Create client
CloudControlsPartnerCoreClient cloudControlsPartnerCoreClient = await CloudControlsPartnerCoreClient.CreateAsync();
// Initialize request argument(s)
PartnerName name = PartnerName.FromOrganizationLocation("[ORGANIZATION]", "[LOCATION]");
// Make the request
Partner response = await cloudControlsPartnerCoreClient.GetPartnerAsync(name);

GetPartnerAsync(PartnerName, CancellationToken)

public virtual Task<Partner> GetPartnerAsync(PartnerName name, CancellationToken cancellationToken)

Get details of a Partner.

Parameters
Name Description
name PartnerName

Required. Format: organizations/{organization}/locations/{location}/partner

cancellationToken CancellationToken

A CancellationToken to use for this RPC.

Returns
Type Description
TaskPartner

A Task containing the RPC response.

Example
// Create client
CloudControlsPartnerCoreClient cloudControlsPartnerCoreClient = await CloudControlsPartnerCoreClient.CreateAsync();
// Initialize request argument(s)
PartnerName name = PartnerName.FromOrganizationLocation("[ORGANIZATION]", "[LOCATION]");
// Make the request
Partner response = await cloudControlsPartnerCoreClient.GetPartnerAsync(name);

GetPartnerAsync(string, CallSettings)

public virtual Task<Partner> GetPartnerAsync(string name, CallSettings callSettings = null)

Get details of a Partner.

Parameters
Name Description
name string

Required. Format: organizations/{organization}/locations/{location}/partner

callSettings CallSettings

If not null, applies overrides to this RPC call.

Returns
Type Description
TaskPartner

A Task containing the RPC response.

Example
// Create client
CloudControlsPartnerCoreClient cloudControlsPartnerCoreClient = await CloudControlsPartnerCoreClient.CreateAsync();
// Initialize request argument(s)
string name = "organizations/[ORGANIZATION]/locations/[LOCATION]/partner";
// Make the request
Partner response = await cloudControlsPartnerCoreClient.GetPartnerAsync(name);

GetPartnerAsync(string, CancellationToken)

public virtual Task<Partner> GetPartnerAsync(string name, CancellationToken cancellationToken)

Get details of a Partner.

Parameters
Name Description
name string

Required. Format: organizations/{organization}/locations/{location}/partner

cancellationToken CancellationToken

A CancellationToken to use for this RPC.

Returns
Type Description
TaskPartner

A Task containing the RPC response.

Example
// Create client
CloudControlsPartnerCoreClient cloudControlsPartnerCoreClient = await CloudControlsPartnerCoreClient.CreateAsync();
// Initialize request argument(s)
string name = "organizations/[ORGANIZATION]/locations/[LOCATION]/partner";
// Make the request
Partner response = await cloudControlsPartnerCoreClient.GetPartnerAsync(name);

GetPartnerPermissions(GetPartnerPermissionsRequest, CallSettings)

public virtual PartnerPermissions GetPartnerPermissions(GetPartnerPermissionsRequest request, CallSettings callSettings = null)

Gets the partner permissions granted for a workload

Parameters
Name Description
request GetPartnerPermissionsRequest

The request object containing all of the parameters for the API call.

callSettings CallSettings

If not null, applies overrides to this RPC call.

Returns
Type Description
PartnerPermissions

The RPC response.

Example
// Create client
CloudControlsPartnerCoreClient cloudControlsPartnerCoreClient = CloudControlsPartnerCoreClient.Create();
// Initialize request argument(s)
GetPartnerPermissionsRequest request = new GetPartnerPermissionsRequest
{
    PartnerPermissionsName = PartnerPermissionsName.FromOrganizationLocationCustomerWorkload("[ORGANIZATION]", "[LOCATION]", "[CUSTOMER]", "[WORKLOAD]"),
};
// Make the request
PartnerPermissions response = cloudControlsPartnerCoreClient.GetPartnerPermissions(request);

GetPartnerPermissions(PartnerPermissionsName, CallSettings)

public virtual PartnerPermissions GetPartnerPermissions(PartnerPermissionsName name, CallSettings callSettings = null)

Gets the partner permissions granted for a workload

Parameters
Name Description
name PartnerPermissionsName

Required. Name of the resource to get in the format: organizations/{organization}/locations/{location}/customers/{customer}/workloads/{workload}/partnerPermissions

callSettings CallSettings

If not null, applies overrides to this RPC call.

Returns
Type Description
PartnerPermissions

The RPC response.

Example
// Create client
CloudControlsPartnerCoreClient cloudControlsPartnerCoreClient = CloudControlsPartnerCoreClient.Create();
// Initialize request argument(s)
PartnerPermissionsName name = PartnerPermissionsName.FromOrganizationLocationCustomerWorkload("[ORGANIZATION]", "[LOCATION]", "[CUSTOMER]", "[WORKLOAD]");
// Make the request
PartnerPermissions response = cloudControlsPartnerCoreClient.GetPartnerPermissions(name);

GetPartnerPermissions(string, CallSettings)

public virtual PartnerPermissions GetPartnerPermissions(string name, CallSettings callSettings = null)

Gets the partner permissions granted for a workload

Parameters
Name Description
name string

Required. Name of the resource to get in the format: organizations/{organization}/locations/{location}/customers/{customer}/workloads/{workload}/partnerPermissions

callSettings CallSettings

If not null, applies overrides to this RPC call.

Returns
Type Description
PartnerPermissions

The RPC response.

Example
// Create client
CloudControlsPartnerCoreClient cloudControlsPartnerCoreClient = CloudControlsPartnerCoreClient.Create();
// Initialize request argument(s)
string name = "organizations/[ORGANIZATION]/locations/[LOCATION]/customers/[CUSTOMER]/workloads/[WORKLOAD]/partnerPermissions";
// Make the request
PartnerPermissions response = cloudControlsPartnerCoreClient.GetPartnerPermissions(name);

GetPartnerPermissionsAsync(GetPartnerPermissionsRequest, CallSettings)

public virtual Task<PartnerPermissions> GetPartnerPermissionsAsync(GetPartnerPermissionsRequest request, CallSettings callSettings = null)

Gets the partner permissions granted for a workload

Parameters
Name Description
request GetPartnerPermissionsRequest

The request object containing all of the parameters for the API call.

callSettings CallSettings

If not null, applies overrides to this RPC call.

Returns
Type Description
TaskPartnerPermissions

A Task containing the RPC response.

Example
// Create client
CloudControlsPartnerCoreClient cloudControlsPartnerCoreClient = await CloudControlsPartnerCoreClient.CreateAsync();
// Initialize request argument(s)
GetPartnerPermissionsRequest request = new GetPartnerPermissionsRequest
{
    PartnerPermissionsName = PartnerPermissionsName.FromOrganizationLocationCustomerWorkload("[ORGANIZATION]", "[LOCATION]", "[CUSTOMER]", "[WORKLOAD]"),
};
// Make the request
PartnerPermissions response = await cloudControlsPartnerCoreClient.GetPartnerPermissionsAsync(request);

GetPartnerPermissionsAsync(GetPartnerPermissionsRequest, CancellationToken)

public virtual Task<PartnerPermissions> GetPartnerPermissionsAsync(GetPartnerPermissionsRequest request, CancellationToken cancellationToken)

Gets the partner permissions granted for a workload

Parameters
Name Description
request GetPartnerPermissionsRequest

The request object containing all of the parameters for the API call.

cancellationToken CancellationToken

A CancellationToken to use for this RPC.

Returns
Type Description
TaskPartnerPermissions

A Task containing the RPC response.

Example
// Create client
CloudControlsPartnerCoreClient cloudControlsPartnerCoreClient = await CloudControlsPartnerCoreClient.CreateAsync();
// Initialize request argument(s)
GetPartnerPermissionsRequest request = new GetPartnerPermissionsRequest
{
    PartnerPermissionsName = PartnerPermissionsName.FromOrganizationLocationCustomerWorkload("[ORGANIZATION]", "[LOCATION]", "[CUSTOMER]", "[WORKLOAD]"),
};
// Make the request
PartnerPermissions response = await cloudControlsPartnerCoreClient.GetPartnerPermissionsAsync(request);

GetPartnerPermissionsAsync(PartnerPermissionsName, CallSettings)

public virtual Task<PartnerPermissions> GetPartnerPermissionsAsync(PartnerPermissionsName name, CallSettings callSettings = null)

Gets the partner permissions granted for a workload

Parameters
Name Description
name PartnerPermissionsName

Required. Name of the resource to get in the format: organizations/{organization}/locations/{location}/customers/{customer}/workloads/{workload}/partnerPermissions

callSettings CallSettings

If not null, applies overrides to this RPC call.

Returns
Type Description
TaskPartnerPermissions

A Task containing the RPC response.

Example
// Create client
CloudControlsPartnerCoreClient cloudControlsPartnerCoreClient = await CloudControlsPartnerCoreClient.CreateAsync();
// Initialize request argument(s)
PartnerPermissionsName name = PartnerPermissionsName.FromOrganizationLocationCustomerWorkload("[ORGANIZATION]", "[LOCATION]", "[CUSTOMER]", "[WORKLOAD]");
// Make the request
PartnerPermissions response = await cloudControlsPartnerCoreClient.GetPartnerPermissionsAsync(name);

GetPartnerPermissionsAsync(PartnerPermissionsName, CancellationToken)

public virtual Task<PartnerPermissions> GetPartnerPermissionsAsync(PartnerPermissionsName name, CancellationToken cancellationToken)

Gets the partner permissions granted for a workload

Parameters
Name Description
name PartnerPermissionsName

Required. Name of the resource to get in the format: organizations/{organization}/locations/{location}/customers/{customer}/workloads/{workload}/partnerPermissions

cancellationToken CancellationToken

A CancellationToken to use for this RPC.

Returns
Type Description
TaskPartnerPermissions

A Task containing the RPC response.

Example
// Create client
CloudControlsPartnerCoreClient cloudControlsPartnerCoreClient = await CloudControlsPartnerCoreClient.CreateAsync();
// Initialize request argument(s)
PartnerPermissionsName name = PartnerPermissionsName.FromOrganizationLocationCustomerWorkload("[ORGANIZATION]", "[LOCATION]", "[CUSTOMER]", "[WORKLOAD]");
// Make the request
PartnerPermissions response = await cloudControlsPartnerCoreClient.GetPartnerPermissionsAsync(name);

GetPartnerPermissionsAsync(string, CallSettings)

public virtual Task<PartnerPermissions> GetPartnerPermissionsAsync(string name, CallSettings callSettings = null)

Gets the partner permissions granted for a workload

Parameters
Name Description
name string

Required. Name of the resource to get in the format: organizations/{organization}/locations/{location}/customers/{customer}/workloads/{workload}/partnerPermissions

callSettings CallSettings

If not null, applies overrides to this RPC call.

Returns
Type Description
TaskPartnerPermissions

A Task containing the RPC response.

Example
// Create client
CloudControlsPartnerCoreClient cloudControlsPartnerCoreClient = await CloudControlsPartnerCoreClient.CreateAsync();
// Initialize request argument(s)
string name = "organizations/[ORGANIZATION]/locations/[LOCATION]/customers/[CUSTOMER]/workloads/[WORKLOAD]/partnerPermissions";
// Make the request
PartnerPermissions response = await cloudControlsPartnerCoreClient.GetPartnerPermissionsAsync(name);

GetPartnerPermissionsAsync(string, CancellationToken)

public virtual Task<PartnerPermissions> GetPartnerPermissionsAsync(string name, CancellationToken cancellationToken)

Gets the partner permissions granted for a workload

Parameters
Name Description
name string

Required. Name of the resource to get in the format: organizations/{organization}/locations/{location}/customers/{customer}/workloads/{workload}/partnerPermissions

cancellationToken CancellationToken

A CancellationToken to use for this RPC.

Returns
Type Description
TaskPartnerPermissions

A Task containing the RPC response.

Example
// Create client
CloudControlsPartnerCoreClient cloudControlsPartnerCoreClient = await CloudControlsPartnerCoreClient.CreateAsync();
// Initialize request argument(s)
string name = "organizations/[ORGANIZATION]/locations/[LOCATION]/customers/[CUSTOMER]/workloads/[WORKLOAD]/partnerPermissions";
// Make the request
PartnerPermissions response = await cloudControlsPartnerCoreClient.GetPartnerPermissionsAsync(name);

GetWorkload(GetWorkloadRequest, CallSettings)

public virtual Workload GetWorkload(GetWorkloadRequest request, CallSettings callSettings = null)

Gets details of a single workload

Parameters
Name Description
request GetWorkloadRequest

The request object containing all of the parameters for the API call.

callSettings CallSettings

If not null, applies overrides to this RPC call.

Returns
Type Description
Workload

The RPC response.

Example
// Create client
CloudControlsPartnerCoreClient cloudControlsPartnerCoreClient = CloudControlsPartnerCoreClient.Create();
// Initialize request argument(s)
GetWorkloadRequest request = new GetWorkloadRequest
{
    WorkloadName = WorkloadName.FromOrganizationLocationCustomerWorkload("[ORGANIZATION]", "[LOCATION]", "[CUSTOMER]", "[WORKLOAD]"),
};
// Make the request
Workload response = cloudControlsPartnerCoreClient.GetWorkload(request);

GetWorkload(WorkloadName, CallSettings)

public virtual Workload GetWorkload(WorkloadName name, CallSettings callSettings = null)

Gets details of a single workload

Parameters
Name Description
name WorkloadName

Required. Format: organizations/{organization}/locations/{location}/customers/{customer}/workloads/{workload}

callSettings CallSettings

If not null, applies overrides to this RPC call.

Returns
Type Description
Workload

The RPC response.

Example
// Create client
CloudControlsPartnerCoreClient cloudControlsPartnerCoreClient = CloudControlsPartnerCoreClient.Create();
// Initialize request argument(s)
WorkloadName name = WorkloadName.FromOrganizationLocationCustomerWorkload("[ORGANIZATION]", "[LOCATION]", "[CUSTOMER]", "[WORKLOAD]");
// Make the request
Workload response = cloudControlsPartnerCoreClient.GetWorkload(name);

GetWorkload(string, CallSettings)

public virtual Workload GetWorkload(string name, CallSettings callSettings = null)

Gets details of a single workload

Parameters
Name Description
name string

Required. Format: organizations/{organization}/locations/{location}/customers/{customer}/workloads/{workload}

callSettings CallSettings

If not null, applies overrides to this RPC call.

Returns
Type Description
Workload

The RPC response.

Example
// Create client
CloudControlsPartnerCoreClient cloudControlsPartnerCoreClient = CloudControlsPartnerCoreClient.Create();
// Initialize request argument(s)
string name = "organizations/[ORGANIZATION]/locations/[LOCATION]/customers/[CUSTOMER]/workloads/[WORKLOAD]";
// Make the request
Workload response = cloudControlsPartnerCoreClient.GetWorkload(name);

GetWorkloadAsync(GetWorkloadRequest, CallSettings)

public virtual Task<Workload> GetWorkloadAsync(GetWorkloadRequest request, CallSettings callSettings = null)

Gets details of a single workload

Parameters
Name Description
request GetWorkloadRequest

The request object containing all of the parameters for the API call.

callSettings CallSettings

If not null, applies overrides to this RPC call.

Returns
Type Description
TaskWorkload

A Task containing the RPC response.

Example
// Create client
CloudControlsPartnerCoreClient cloudControlsPartnerCoreClient = await CloudControlsPartnerCoreClient.CreateAsync();
// Initialize request argument(s)
GetWorkloadRequest request = new GetWorkloadRequest
{
    WorkloadName = WorkloadName.FromOrganizationLocationCustomerWorkload("[ORGANIZATION]", "[LOCATION]", "[CUSTOMER]", "[WORKLOAD]"),
};
// Make the request
Workload response = await cloudControlsPartnerCoreClient.GetWorkloadAsync(request);

GetWorkloadAsync(GetWorkloadRequest, CancellationToken)

public virtual Task<Workload> GetWorkloadAsync(GetWorkloadRequest request, CancellationToken cancellationToken)

Gets details of a single workload

Parameters
Name Description
request GetWorkloadRequest

The request object containing all of the parameters for the API call.

cancellationToken CancellationToken

A CancellationToken to use for this RPC.

Returns
Type Description
TaskWorkload

A Task containing the RPC response.

Example
// Create client
CloudControlsPartnerCoreClient cloudControlsPartnerCoreClient = await CloudControlsPartnerCoreClient.CreateAsync();
// Initialize request argument(s)
GetWorkloadRequest request = new GetWorkloadRequest
{
    WorkloadName = WorkloadName.FromOrganizationLocationCustomerWorkload("[ORGANIZATION]", "[LOCATION]", "[CUSTOMER]", "[WORKLOAD]"),
};
// Make the request
Workload response = await cloudControlsPartnerCoreClient.GetWorkloadAsync(request);

GetWorkloadAsync(WorkloadName, CallSettings)

public virtual Task<Workload> GetWorkloadAsync(WorkloadName name, CallSettings callSettings = null)

Gets details of a single workload

Parameters
Name Description
name WorkloadName

Required. Format: organizations/{organization}/locations/{location}/customers/{customer}/workloads/{workload}

callSettings CallSettings

If not null, applies overrides to this RPC call.

Returns
Type Description
TaskWorkload

A Task containing the RPC response.

Example
// Create client
CloudControlsPartnerCoreClient cloudControlsPartnerCoreClient = await CloudControlsPartnerCoreClient.CreateAsync();
// Initialize request argument(s)
WorkloadName name = WorkloadName.FromOrganizationLocationCustomerWorkload("[ORGANIZATION]", "[LOCATION]", "[CUSTOMER]", "[WORKLOAD]");
// Make the request
Workload response = await cloudControlsPartnerCoreClient.GetWorkloadAsync(name);

GetWorkloadAsync(WorkloadName, CancellationToken)

public virtual Task<Workload> GetWorkloadAsync(WorkloadName name, CancellationToken cancellationToken)

Gets details of a single workload

Parameters
Name Description
name WorkloadName

Required. Format: organizations/{organization}/locations/{location}/customers/{customer}/workloads/{workload}

cancellationToken CancellationToken

A CancellationToken to use for this RPC.

Returns
Type Description
TaskWorkload

A Task containing the RPC response.

Example
// Create client
CloudControlsPartnerCoreClient cloudControlsPartnerCoreClient = await CloudControlsPartnerCoreClient.CreateAsync();
// Initialize request argument(s)
WorkloadName name = WorkloadName.FromOrganizationLocationCustomerWorkload("[ORGANIZATION]", "[LOCATION]", "[CUSTOMER]", "[WORKLOAD]");
// Make the request
Workload response = await cloudControlsPartnerCoreClient.GetWorkloadAsync(name);

GetWorkloadAsync(string, CallSettings)

public virtual Task<Workload> GetWorkloadAsync(string name, CallSettings callSettings = null)

Gets details of a single workload

Parameters
Name Description
name string

Required. Format: organizations/{organization}/locations/{location}/customers/{customer}/workloads/{workload}

callSettings CallSettings

If not null, applies overrides to this RPC call.

Returns
Type Description
TaskWorkload

A Task containing the RPC response.

Example
// Create client
CloudControlsPartnerCoreClient cloudControlsPartnerCoreClient = await CloudControlsPartnerCoreClient.CreateAsync();
// Initialize request argument(s)
string name = "organizations/[ORGANIZATION]/locations/[LOCATION]/customers/[CUSTOMER]/workloads/[WORKLOAD]";
// Make the request
Workload response = await cloudControlsPartnerCoreClient.GetWorkloadAsync(name);

GetWorkloadAsync(string, CancellationToken)

public virtual Task<Workload> GetWorkloadAsync(string name, CancellationToken cancellationToken)

Gets details of a single workload

Parameters
Name Description
name string

Required. Format: organizations/{organization}/locations/{location}/customers/{customer}/workloads/{workload}

cancellationToken CancellationToken

A CancellationToken to use for this RPC.

Returns
Type Description
TaskWorkload

A Task containing the RPC response.

Example
// Create client
CloudControlsPartnerCoreClient cloudControlsPartnerCoreClient = await CloudControlsPartnerCoreClient.CreateAsync();
// Initialize request argument(s)
string name = "organizations/[ORGANIZATION]/locations/[LOCATION]/customers/[CUSTOMER]/workloads/[WORKLOAD]";
// Make the request
Workload response = await cloudControlsPartnerCoreClient.GetWorkloadAsync(name);

ListAccessApprovalRequests(ListAccessApprovalRequestsRequest, CallSettings)

[Obsolete]
public virtual PagedEnumerable<ListAccessApprovalRequestsResponse, AccessApprovalRequest> ListAccessApprovalRequests(ListAccessApprovalRequestsRequest request, CallSettings callSettings = null)

Deprecated: Only returns access approval requests directly associated with an assured workload folder.

Parameters
Name Description
request ListAccessApprovalRequestsRequest

The request object containing all of the parameters for the API call.

callSettings CallSettings

If not null, applies overrides to this RPC call.

Returns
Type Description
PagedEnumerableListAccessApprovalRequestsResponseAccessApprovalRequest

A pageable sequence of AccessApprovalRequest resources.

Example
            // Create client
            CloudControlsPartnerCoreClient cloudControlsPartnerCoreClient = CloudControlsPartnerCoreClient.Create();
            // Initialize request argument(s)
            ListAccessApprovalRequestsRequest request = new ListAccessApprovalRequestsRequest
            {
                ParentAsWorkloadName = WorkloadName.FromOrganizationLocationCustomerWorkload("[ORGANIZATION]", "[LOCATION]", "[CUSTOMER]", "[WORKLOAD]"),
                Filter = "",
                OrderBy = "",
            };
            // Make the request
#pragma warning disable CS0612
            PagedEnumerable<ListAccessApprovalRequestsResponse, AccessApprovalRequest> response = cloudControlsPartnerCoreClient.ListAccessApprovalRequests(request);
#pragma warning restore CS0612

            // Iterate over all response items, lazily performing RPCs as required
            foreach (AccessApprovalRequest item in response)
            {
                // Do something with each item
                Console.WriteLine(item);
            }

            // Or iterate over pages (of server-defined size), performing one RPC per page
            foreach (ListAccessApprovalRequestsResponse page in response.AsRawResponses())
            {
                // Do something with each page of items
                Console.WriteLine("A page of results:");
                foreach (AccessApprovalRequest item in page)
                {
                    // Do something with each item
                    Console.WriteLine(item);
                }
            }

            // Or retrieve a single page of known size (unless it's the final page), performing as many RPCs as required
            int pageSize = 10;
            Page<AccessApprovalRequest> singlePage = response.ReadPage(pageSize);
            // Do something with the page of items
            Console.WriteLine($"A page of {pageSize} results (unless it's the final page):");
            foreach (AccessApprovalRequest item in singlePage)
            {
                // Do something with each item
                Console.WriteLine(item);
            }
            // Store the pageToken, for when the next page is required.
            string nextPageToken = singlePage.NextPageToken;

ListAccessApprovalRequests(WorkloadName, string, int?, CallSettings)

[Obsolete]
public virtual PagedEnumerable<ListAccessApprovalRequestsResponse, AccessApprovalRequest> ListAccessApprovalRequests(WorkloadName parent, string pageToken = null, int? pageSize = null, CallSettings callSettings = null)

Deprecated: Only returns access approval requests directly associated with an assured workload folder.

Parameters
Name Description
parent WorkloadName

Required. Parent resource Format: organizations/{organization}/locations/{location}/customers/{customer}/workloads/{workload}

pageToken string

The token returned from the previous request. A value of null or an empty string retrieves the first page.

pageSize int

The size of page to request. The response will not be larger than this, but may be smaller. A value of null or 0 uses a server-defined page size.

callSettings CallSettings

If not null, applies overrides to this RPC call.

Returns
Type Description
PagedEnumerableListAccessApprovalRequestsResponseAccessApprovalRequest

A pageable sequence of AccessApprovalRequest resources.

Example
            // Create client
            CloudControlsPartnerCoreClient cloudControlsPartnerCoreClient = CloudControlsPartnerCoreClient.Create();
            // Initialize request argument(s)
            WorkloadName parent = WorkloadName.FromOrganizationLocationCustomerWorkload("[ORGANIZATION]", "[LOCATION]", "[CUSTOMER]", "[WORKLOAD]");
            // Make the request
#pragma warning disable CS0612
            PagedEnumerable<ListAccessApprovalRequestsResponse, AccessApprovalRequest> response = cloudControlsPartnerCoreClient.ListAccessApprovalRequests(parent);
#pragma warning restore CS0612

            // Iterate over all response items, lazily performing RPCs as required
            foreach (AccessApprovalRequest item in response)
            {
                // Do something with each item
                Console.WriteLine(item);
            }

            // Or iterate over pages (of server-defined size), performing one RPC per page
            foreach (ListAccessApprovalRequestsResponse page in response.AsRawResponses())
            {
                // Do something with each page of items
                Console.WriteLine("A page of results:");
                foreach (AccessApprovalRequest item in page)
                {
                    // Do something with each item
                    Console.WriteLine(item);
                }
            }

            // Or retrieve a single page of known size (unless it's the final page), performing as many RPCs as required
            int pageSize = 10;
            Page<AccessApprovalRequest> singlePage = response.ReadPage(pageSize);
            // Do something with the page of items
            Console.WriteLine($"A page of {pageSize} results (unless it's the final page):");
            foreach (AccessApprovalRequest item in singlePage)
            {
                // Do something with each item
                Console.WriteLine(item);
            }
            // Store the pageToken, for when the next page is required.
            string nextPageToken = singlePage.NextPageToken;

ListAccessApprovalRequests(string, string, int?, CallSettings)

[Obsolete]
public virtual PagedEnumerable<ListAccessApprovalRequestsResponse, AccessApprovalRequest> ListAccessApprovalRequests(string parent, string pageToken = null, int? pageSize = null, CallSettings callSettings = null)

Deprecated: Only returns access approval requests directly associated with an assured workload folder.

Parameters
Name Description
parent string

Required. Parent resource Format: organizations/{organization}/locations/{location}/customers/{customer}/workloads/{workload}

pageToken string

The token returned from the previous request. A value of null or an empty string retrieves the first page.

pageSize int

The size of page to request. The response will not be larger than this, but may be smaller. A value of null or 0 uses a server-defined page size.

callSettings CallSettings

If not null, applies overrides to this RPC call.

Returns
Type Description
PagedEnumerableListAccessApprovalRequestsResponseAccessApprovalRequest

A pageable sequence of AccessApprovalRequest resources.

Example
            // Create client
            CloudControlsPartnerCoreClient cloudControlsPartnerCoreClient = CloudControlsPartnerCoreClient.Create();
            // Initialize request argument(s)
            string parent = "organizations/[ORGANIZATION]/locations/[LOCATION]/customers/[CUSTOMER]/workloads/[WORKLOAD]";
            // Make the request
#pragma warning disable CS0612
            PagedEnumerable<ListAccessApprovalRequestsResponse, AccessApprovalRequest> response = cloudControlsPartnerCoreClient.ListAccessApprovalRequests(parent);
#pragma warning restore CS0612

            // Iterate over all response items, lazily performing RPCs as required
            foreach (AccessApprovalRequest item in response)
            {
                // Do something with each item
                Console.WriteLine(item);
            }

            // Or iterate over pages (of server-defined size), performing one RPC per page
            foreach (ListAccessApprovalRequestsResponse page in response.AsRawResponses())
            {
                // Do something with each page of items
                Console.WriteLine("A page of results:");
                foreach (AccessApprovalRequest item in page)
                {
                    // Do something with each item
                    Console.WriteLine(item);
                }
            }

            // Or retrieve a single page of known size (unless it's the final page), performing as many RPCs as required
            int pageSize = 10;
            Page<AccessApprovalRequest> singlePage = response.ReadPage(pageSize);
            // Do something with the page of items
            Console.WriteLine($"A page of {pageSize} results (unless it's the final page):");
            foreach (AccessApprovalRequest item in singlePage)
            {
                // Do something with each item
                Console.WriteLine(item);
            }
            // Store the pageToken, for when the next page is required.
            string nextPageToken = singlePage.NextPageToken;

ListAccessApprovalRequestsAsync(ListAccessApprovalRequestsRequest, CallSettings)

[Obsolete]
public virtual PagedAsyncEnumerable<ListAccessApprovalRequestsResponse, AccessApprovalRequest> ListAccessApprovalRequestsAsync(ListAccessApprovalRequestsRequest request, CallSettings callSettings = null)

Deprecated: Only returns access approval requests directly associated with an assured workload folder.

Parameters
Name Description
request ListAccessApprovalRequestsRequest

The request object containing all of the parameters for the API call.

callSettings CallSettings

If not null, applies overrides to this RPC call.

Returns
Type Description
PagedAsyncEnumerableListAccessApprovalRequestsResponseAccessApprovalRequest

A pageable asynchronous sequence of AccessApprovalRequest resources.

Example
            // Create client
            CloudControlsPartnerCoreClient cloudControlsPartnerCoreClient = await CloudControlsPartnerCoreClient.CreateAsync();
            // Initialize request argument(s)
            ListAccessApprovalRequestsRequest request = new ListAccessApprovalRequestsRequest
            {
                ParentAsWorkloadName = WorkloadName.FromOrganizationLocationCustomerWorkload("[ORGANIZATION]", "[LOCATION]", "[CUSTOMER]", "[WORKLOAD]"),
                Filter = "",
                OrderBy = "",
            };
            // Make the request
#pragma warning disable CS0612
            PagedAsyncEnumerable<ListAccessApprovalRequestsResponse, AccessApprovalRequest> response = cloudControlsPartnerCoreClient.ListAccessApprovalRequestsAsync(request);
#pragma warning restore CS0612

            // Iterate over all response items, lazily performing RPCs as required
            await response.ForEachAsync((AccessApprovalRequest item) =>
            {
                // Do something with each item
                Console.WriteLine(item);
            });

            // Or iterate over pages (of server-defined size), performing one RPC per page
            await response.AsRawResponses().ForEachAsync((ListAccessApprovalRequestsResponse page) =>
            {
                // Do something with each page of items
                Console.WriteLine("A page of results:");
                foreach (AccessApprovalRequest item in page)
                {
                    // Do something with each item
                    Console.WriteLine(item);
                }
            });

            // Or retrieve a single page of known size (unless it's the final page), performing as many RPCs as required
            int pageSize = 10;
            Page<AccessApprovalRequest> singlePage = await response.ReadPageAsync(pageSize);
            // Do something with the page of items
            Console.WriteLine($"A page of {pageSize} results (unless it's the final page):");
            foreach (AccessApprovalRequest item in singlePage)
            {
                // Do something with each item
                Console.WriteLine(item);
            }
            // Store the pageToken, for when the next page is required.
            string nextPageToken = singlePage.NextPageToken;

ListAccessApprovalRequestsAsync(WorkloadName, string, int?, CallSettings)

[Obsolete]
public virtual PagedAsyncEnumerable<ListAccessApprovalRequestsResponse, AccessApprovalRequest> ListAccessApprovalRequestsAsync(WorkloadName parent, string pageToken = null, int? pageSize = null, CallSettings callSettings = null)

Deprecated: Only returns access approval requests directly associated with an assured workload folder.

Parameters
Name Description
parent WorkloadName

Required. Parent resource Format: organizations/{organization}/locations/{location}/customers/{customer}/workloads/{workload}

pageToken string

The token returned from the previous request. A value of null or an empty string retrieves the first page.

pageSize int

The size of page to request. The response will not be larger than this, but may be smaller. A value of null or 0 uses a server-defined page size.

callSettings CallSettings

If not null, applies overrides to this RPC call.

Returns
Type Description
PagedAsyncEnumerableListAccessApprovalRequestsResponseAccessApprovalRequest

A pageable asynchronous sequence of AccessApprovalRequest resources.

Example
            // Create client
            CloudControlsPartnerCoreClient cloudControlsPartnerCoreClient = await CloudControlsPartnerCoreClient.CreateAsync();
            // Initialize request argument(s)
            WorkloadName parent = WorkloadName.FromOrganizationLocationCustomerWorkload("[ORGANIZATION]", "[LOCATION]", "[CUSTOMER]", "[WORKLOAD]");
            // Make the request
#pragma warning disable CS0612
            PagedAsyncEnumerable<ListAccessApprovalRequestsResponse, AccessApprovalRequest> response = cloudControlsPartnerCoreClient.ListAccessApprovalRequestsAsync(parent);
#pragma warning restore CS0612

            // Iterate over all response items, lazily performing RPCs as required
            await response.ForEachAsync((AccessApprovalRequest item) =>
            {
                // Do something with each item
                Console.WriteLine(item);
            });

            // Or iterate over pages (of server-defined size), performing one RPC per page
            await response.AsRawResponses().ForEachAsync((ListAccessApprovalRequestsResponse page) =>
            {
                // Do something with each page of items
                Console.WriteLine("A page of results:");
                foreach (AccessApprovalRequest item in page)
                {
                    // Do something with each item
                    Console.WriteLine(item);
                }
            });

            // Or retrieve a single page of known size (unless it's the final page), performing as many RPCs as required
            int pageSize = 10;
            Page<AccessApprovalRequest> singlePage = await response.ReadPageAsync(pageSize);
            // Do something with the page of items
            Console.WriteLine($"A page of {pageSize} results (unless it's the final page):");
            foreach (AccessApprovalRequest item in singlePage)
            {
                // Do something with each item
                Console.WriteLine(item);
            }
            // Store the pageToken, for when the next page is required.
            string nextPageToken = singlePage.NextPageToken;

ListAccessApprovalRequestsAsync(string, string, int?, CallSettings)

[Obsolete]
public virtual PagedAsyncEnumerable<ListAccessApprovalRequestsResponse, AccessApprovalRequest> ListAccessApprovalRequestsAsync(string parent, string pageToken = null, int? pageSize = null, CallSettings callSettings = null)

Deprecated: Only returns access approval requests directly associated with an assured workload folder.

Parameters
Name Description
parent string

Required. Parent resource Format: organizations/{organization}/locations/{location}/customers/{customer}/workloads/{workload}

pageToken string

The token returned from the previous request. A value of null or an empty string retrieves the first page.

pageSize int

The size of page to request. The response will not be larger than this, but may be smaller. A value of null or 0 uses a server-defined page size.

callSettings CallSettings

If not null, applies overrides to this RPC call.

Returns
Type Description
PagedAsyncEnumerableListAccessApprovalRequestsResponseAccessApprovalRequest

A pageable asynchronous sequence of AccessApprovalRequest resources.

Example
            // Create client
            CloudControlsPartnerCoreClient cloudControlsPartnerCoreClient = await CloudControlsPartnerCoreClient.CreateAsync();
            // Initialize request argument(s)
            string parent = "organizations/[ORGANIZATION]/locations/[LOCATION]/customers/[CUSTOMER]/workloads/[WORKLOAD]";
            // Make the request
#pragma warning disable CS0612
            PagedAsyncEnumerable<ListAccessApprovalRequestsResponse, AccessApprovalRequest> response = cloudControlsPartnerCoreClient.ListAccessApprovalRequestsAsync(parent);
#pragma warning restore CS0612

            // Iterate over all response items, lazily performing RPCs as required
            await response.ForEachAsync((AccessApprovalRequest item) =>
            {
                // Do something with each item
                Console.WriteLine(item);
            });

            // Or iterate over pages (of server-defined size), performing one RPC per page
            await response.AsRawResponses().ForEachAsync((ListAccessApprovalRequestsResponse page) =>
            {
                // Do something with each page of items
                Console.WriteLine("A page of results:");
                foreach (AccessApprovalRequest item in page)
                {
                    // Do something with each item
                    Console.WriteLine(item);
                }
            });

            // Or retrieve a single page of known size (unless it's the final page), performing as many RPCs as required
            int pageSize = 10;
            Page<AccessApprovalRequest> singlePage = await response.ReadPageAsync(pageSize);
            // Do something with the page of items
            Console.WriteLine($"A page of {pageSize} results (unless it's the final page):");
            foreach (AccessApprovalRequest item in singlePage)
            {
                // Do something with each item
                Console.WriteLine(item);
            }
            // Store the pageToken, for when the next page is required.
            string nextPageToken = singlePage.NextPageToken;

ListCustomers(ListCustomersRequest, CallSettings)

public virtual PagedEnumerable<ListCustomersResponse, Customer> ListCustomers(ListCustomersRequest request, CallSettings callSettings = null)

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

Parameters
Name Description
request ListCustomersRequest

The request object containing all of the parameters for the API call.

callSettings CallSettings

If not null, applies overrides to this RPC call.

Returns
Type Description
PagedEnumerableListCustomersResponseCustomer

A pageable sequence of Customer resources.

Example
// Create client
CloudControlsPartnerCoreClient cloudControlsPartnerCoreClient = CloudControlsPartnerCoreClient.Create();
// Initialize request argument(s)
ListCustomersRequest request = new ListCustomersRequest
{
    ParentAsOrganizationLocationName = OrganizationLocationName.FromOrganizationLocation("[ORGANIZATION]", "[LOCATION]"),
    Filter = "",
    OrderBy = "",
};
// Make the request
PagedEnumerable<ListCustomersResponse, Customer> response = cloudControlsPartnerCoreClient.ListCustomers(request);

// Iterate over all response items, lazily performing RPCs as required
foreach (Customer item in response)
{
    // Do something with each item
    Console.WriteLine(item);
}

// Or iterate over pages (of server-defined size), performing one RPC per page
foreach (ListCustomersResponse page in response.AsRawResponses())
{
    // Do something with each page of items
    Console.WriteLine("A page of results:");
    foreach (Customer item in page)
    {
        // Do something with each item
        Console.WriteLine(item);
    }
}

// Or retrieve a single page of known size (unless it's the final page), performing as many RPCs as required
int pageSize = 10;
Page<Customer> singlePage = response.ReadPage(pageSize);
// Do something with the page of items
Console.WriteLine($"A page of {pageSize} results (unless it's the final page):");
foreach (Customer item in singlePage)
{
    // Do something with each item
    Console.WriteLine(item);
}
// Store the pageToken, for when the next page is required.
string nextPageToken = singlePage.NextPageToken;

ListCustomers(OrganizationLocationName, string, int?, CallSettings)

public virtual PagedEnumerable<ListCustomersResponse, Customer> ListCustomers(OrganizationLocationName parent, string pageToken = null, int? pageSize = null, CallSettings callSettings = null)

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

Parameters
Name Description
parent OrganizationLocationName

Required. Parent resource Format: organizations/{organization}/locations/{location}

pageToken string

The token returned from the previous request. A value of null or an empty string retrieves the first page.

pageSize int

The size of page to request. The response will not be larger than this, but may be smaller. A value of null or 0 uses a server-defined page size.

callSettings CallSettings

If not null, applies overrides to this RPC call.

Returns
Type Description
PagedEnumerableListCustomersResponseCustomer

A pageable sequence of Customer resources.

Example
// Create client
CloudControlsPartnerCoreClient cloudControlsPartnerCoreClient = CloudControlsPartnerCoreClient.Create();
// Initialize request argument(s)
OrganizationLocationName parent = OrganizationLocationName.FromOrganizationLocation("[ORGANIZATION]", "[LOCATION]");
// Make the request
PagedEnumerable<ListCustomersResponse, Customer> response = cloudControlsPartnerCoreClient.ListCustomers(parent);

// Iterate over all response items, lazily performing RPCs as required
foreach (Customer item in response)
{
    // Do something with each item
    Console.WriteLine(item);
}

// Or iterate over pages (of server-defined size), performing one RPC per page
foreach (ListCustomersResponse page in response.AsRawResponses())
{
    // Do something with each page of items
    Console.WriteLine("A page of results:");
    foreach (Customer item in page)
    {
        // Do something with each item
        Console.WriteLine(item);
    }
}

// Or retrieve a single page of known size (unless it's the final page), performing as many RPCs as required
int pageSize = 10;
Page<Customer> singlePage = response.ReadPage(pageSize);
// Do something with the page of items
Console.WriteLine($"A page of {pageSize} results (unless it's the final page):");
foreach (Customer item in singlePage)
{
    // Do something with each item
    Console.WriteLine(item);
}
// Store the pageToken, for when the next page is required.
string nextPageToken = singlePage.NextPageToken;

ListCustomers(string, string, int?, CallSettings)

public virtual PagedEnumerable<ListCustomersResponse, Customer> ListCustomers(string parent, string pageToken = null, int? pageSize = null, CallSettings callSettings = null)

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

Parameters
Name Description
parent string

Required. Parent resource Format: organizations/{organization}/locations/{location}

pageToken string

The token returned from the previous request. A value of null or an empty string retrieves the first page.

pageSize int

The size of page to request. The response will not be larger than this, but may be smaller. A value of null or 0 uses a server-defined page size.

callSettings CallSettings

If not null, applies overrides to this RPC call.

Returns
Type Description
PagedEnumerableListCustomersResponseCustomer

A pageable sequence of Customer resources.

Example
// Create client
CloudControlsPartnerCoreClient cloudControlsPartnerCoreClient = CloudControlsPartnerCoreClient.Create();
// Initialize request argument(s)
string parent = "organizations/[ORGANIZATION]/locations/[LOCATION]";
// Make the request
PagedEnumerable<ListCustomersResponse, Customer> response = cloudControlsPartnerCoreClient.ListCustomers(parent);

// Iterate over all response items, lazily performing RPCs as required
foreach (Customer item in response)
{
    // Do something with each item
    Console.WriteLine(item);
}

// Or iterate over pages (of server-defined size), performing one RPC per page
foreach (ListCustomersResponse page in response.AsRawResponses())
{
    // Do something with each page of items
    Console.WriteLine("A page of results:");
    foreach (Customer item in page)
    {
        // Do something with each item
        Console.WriteLine(item);
    }
}

// Or retrieve a single page of known size (unless it's the final page), performing as many RPCs as required
int pageSize = 10;
Page<Customer> singlePage = response.ReadPage(pageSize);
// Do something with the page of items
Console.WriteLine($"A page of {pageSize} results (unless it's the final page):");
foreach (Customer item in singlePage)
{
    // Do something with each item
    Console.WriteLine(item);
}
// Store the pageToken, for when the next page is required.
string nextPageToken = singlePage.NextPageToken;

ListCustomersAsync(ListCustomersRequest, CallSettings)

public virtual PagedAsyncEnumerable<ListCustomersResponse, Customer> ListCustomersAsync(ListCustomersRequest request, CallSettings callSettings = null)

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

Parameters
Name Description
request ListCustomersRequest

The request object containing all of the parameters for the API call.

callSettings CallSettings

If not null, applies overrides to this RPC call.

Returns
Type Description
PagedAsyncEnumerableListCustomersResponseCustomer

A pageable asynchronous sequence of Customer resources.

Example
// Create client
CloudControlsPartnerCoreClient cloudControlsPartnerCoreClient = await CloudControlsPartnerCoreClient.CreateAsync();
// Initialize request argument(s)
ListCustomersRequest request = new ListCustomersRequest
{
    ParentAsOrganizationLocationName = OrganizationLocationName.FromOrganizationLocation("[ORGANIZATION]", "[LOCATION]"),
    Filter = "",
    OrderBy = "",
};
// Make the request
PagedAsyncEnumerable<ListCustomersResponse, Customer> response = cloudControlsPartnerCoreClient.ListCustomersAsync(request);

// Iterate over all response items, lazily performing RPCs as required
await response.ForEachAsync((Customer item) =>
{
    // Do something with each item
    Console.WriteLine(item);
});

// Or iterate over pages (of server-defined size), performing one RPC per page
await response.AsRawResponses().ForEachAsync((ListCustomersResponse page) =>
{
    // Do something with each page of items
    Console.WriteLine("A page of results:");
    foreach (Customer item in page)
    {
        // Do something with each item
        Console.WriteLine(item);
    }
});

// Or retrieve a single page of known size (unless it's the final page), performing as many RPCs as required
int pageSize = 10;
Page<Customer> singlePage = await response.ReadPageAsync(pageSize);
// Do something with the page of items
Console.WriteLine($"A page of {pageSize} results (unless it's the final page):");
foreach (Customer item in singlePage)
{
    // Do something with each item
    Console.WriteLine(item);
}
// Store the pageToken, for when the next page is required.
string nextPageToken = singlePage.NextPageToken;

ListCustomersAsync(OrganizationLocationName, string, int?, CallSettings)

public virtual PagedAsyncEnumerable<ListCustomersResponse, Customer> ListCustomersAsync(OrganizationLocationName parent, string pageToken = null, int? pageSize = null, CallSettings callSettings = null)

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

Parameters
Name Description
parent OrganizationLocationName

Required. Parent resource Format: organizations/{organization}/locations/{location}

pageToken string

The token returned from the previous request. A value of null or an empty string retrieves the first page.

pageSize int

The size of page to request. The response will not be larger than this, but may be smaller. A value of null or 0 uses a server-defined page size.

callSettings CallSettings

If not null, applies overrides to this RPC call.

Returns
Type Description
PagedAsyncEnumerableListCustomersResponseCustomer

A pageable asynchronous sequence of Customer resources.

Example
// Create client
CloudControlsPartnerCoreClient cloudControlsPartnerCoreClient = await CloudControlsPartnerCoreClient.CreateAsync();
// Initialize request argument(s)
OrganizationLocationName parent = OrganizationLocationName.FromOrganizationLocation("[ORGANIZATION]", "[LOCATION]");
// Make the request
PagedAsyncEnumerable<ListCustomersResponse, Customer> response = cloudControlsPartnerCoreClient.ListCustomersAsync(parent);

// Iterate over all response items, lazily performing RPCs as required
await response.ForEachAsync((Customer item) =>
{
    // Do something with each item
    Console.WriteLine(item);
});

// Or iterate over pages (of server-defined size), performing one RPC per page
await response.AsRawResponses().ForEachAsync((ListCustomersResponse page) =>
{
    // Do something with each page of items
    Console.WriteLine("A page of results:");
    foreach (Customer item in page)
    {
        // Do something with each item
        Console.WriteLine(item);
    }
});

// Or retrieve a single page of known size (unless it's the final page), performing as many RPCs as required
int pageSize = 10;
Page<Customer> singlePage = await response.ReadPageAsync(pageSize);
// Do something with the page of items
Console.WriteLine($"A page of {pageSize} results (unless it's the final page):");
foreach (Customer item in singlePage)
{
    // Do something with each item
    Console.WriteLine(item);
}
// Store the pageToken, for when the next page is required.
string nextPageToken = singlePage.NextPageToken;

ListCustomersAsync(string, string, int?, CallSettings)

public virtual PagedAsyncEnumerable<ListCustomersResponse, Customer> ListCustomersAsync(string parent, string pageToken = null, int? pageSize = null, CallSettings callSettings = null)

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

Parameters
Name Description
parent string

Required. Parent resource Format: organizations/{organization}/locations/{location}

pageToken string

The token returned from the previous request. A value of null or an empty string retrieves the first page.

pageSize int

The size of page to request. The response will not be larger than this, but may be smaller. A value of null or 0 uses a server-defined page size.

callSettings CallSettings

If not null, applies overrides to this RPC call.

Returns
Type Description
PagedAsyncEnumerableListCustomersResponseCustomer

A pageable asynchronous sequence of Customer resources.

Example
// Create client
CloudControlsPartnerCoreClient cloudControlsPartnerCoreClient = await CloudControlsPartnerCoreClient.CreateAsync();
// Initialize request argument(s)
string parent = "organizations/[ORGANIZATION]/locations/[LOCATION]";
// Make the request
PagedAsyncEnumerable<ListCustomersResponse, Customer> response = cloudControlsPartnerCoreClient.ListCustomersAsync(parent);

// Iterate over all response items, lazily performing RPCs as required
await response.ForEachAsync((Customer item) =>
{
    // Do something with each item
    Console.WriteLine(item);
});

// Or iterate over pages (of server-defined size), performing one RPC per page
await response.AsRawResponses().ForEachAsync((ListCustomersResponse page) =>
{
    // Do something with each page of items
    Console.WriteLine("A page of results:");
    foreach (Customer item in page)
    {
        // Do something with each item
        Console.WriteLine(item);
    }
});

// Or retrieve a single page of known size (unless it's the final page), performing as many RPCs as required
int pageSize = 10;
Page<Customer> singlePage = await response.ReadPageAsync(pageSize);
// Do something with the page of items
Console.WriteLine($"A page of {pageSize} results (unless it's the final page):");
foreach (Customer item in singlePage)
{
    // Do something with each item
    Console.WriteLine(item);
}
// Store the pageToken, for when the next page is required.
string nextPageToken = singlePage.NextPageToken;

ListWorkloads(CustomerName, string, int?, CallSettings)

public virtual PagedEnumerable<ListWorkloadsResponse, Workload> ListWorkloads(CustomerName parent, string pageToken = null, int? pageSize = null, CallSettings callSettings = null)

Lists customer workloads for a given customer org id

Parameters
Name Description
parent CustomerName

Required. Parent resource Format: organizations/{organization}/locations/{location}/customers/{customer}

pageToken string

The token returned from the previous request. A value of null or an empty string retrieves the first page.

pageSize int

The size of page to request. The response will not be larger than this, but may be smaller. A value of null or 0 uses a server-defined page size.

callSettings CallSettings

If not null, applies overrides to this RPC call.

Returns
Type Description
PagedEnumerableListWorkloadsResponseWorkload

A pageable sequence of Workload resources.

Example
// Create client
CloudControlsPartnerCoreClient cloudControlsPartnerCoreClient = CloudControlsPartnerCoreClient.Create();
// Initialize request argument(s)
CustomerName parent = CustomerName.FromOrganizationLocationCustomer("[ORGANIZATION]", "[LOCATION]", "[CUSTOMER]");
// Make the request
PagedEnumerable<ListWorkloadsResponse, Workload> response = cloudControlsPartnerCoreClient.ListWorkloads(parent);

// Iterate over all response items, lazily performing RPCs as required
foreach (Workload item in response)
{
    // Do something with each item
    Console.WriteLine(item);
}

// Or iterate over pages (of server-defined size), performing one RPC per page
foreach (ListWorkloadsResponse page in response.AsRawResponses())
{
    // Do something with each page of items
    Console.WriteLine("A page of results:");
    foreach (Workload item in page)
    {
        // Do something with each item
        Console.WriteLine(item);
    }
}

// Or retrieve a single page of known size (unless it's the final page), performing as many RPCs as required
int pageSize = 10;
Page<Workload> singlePage = response.ReadPage(pageSize);
// Do something with the page of items
Console.WriteLine($"A page of {pageSize} results (unless it's the final page):");
foreach (Workload item in singlePage)
{
    // Do something with each item
    Console.WriteLine(item);
}
// Store the pageToken, for when the next page is required.
string nextPageToken = singlePage.NextPageToken;

ListWorkloads(ListWorkloadsRequest, CallSettings)

public virtual PagedEnumerable<ListWorkloadsResponse, Workload> ListWorkloads(ListWorkloadsRequest request, CallSettings callSettings = null)

Lists customer workloads for a given customer org id

Parameters
Name Description
request ListWorkloadsRequest

The request object containing all of the parameters for the API call.

callSettings CallSettings

If not null, applies overrides to this RPC call.

Returns
Type Description
PagedEnumerableListWorkloadsResponseWorkload

A pageable sequence of Workload resources.

Example
// Create client
CloudControlsPartnerCoreClient cloudControlsPartnerCoreClient = CloudControlsPartnerCoreClient.Create();
// Initialize request argument(s)
ListWorkloadsRequest request = new ListWorkloadsRequest
{
    ParentAsCustomerName = CustomerName.FromOrganizationLocationCustomer("[ORGANIZATION]", "[LOCATION]", "[CUSTOMER]"),
    Filter = "",
    OrderBy = "",
};
// Make the request
PagedEnumerable<ListWorkloadsResponse, Workload> response = cloudControlsPartnerCoreClient.ListWorkloads(request);

// Iterate over all response items, lazily performing RPCs as required
foreach (Workload item in response)
{
    // Do something with each item
    Console.WriteLine(item);
}

// Or iterate over pages (of server-defined size), performing one RPC per page
foreach (ListWorkloadsResponse page in response.AsRawResponses())
{
    // Do something with each page of items
    Console.WriteLine("A page of results:");
    foreach (Workload item in page)
    {
        // Do something with each item
        Console.WriteLine(item);
    }
}

// Or retrieve a single page of known size (unless it's the final page), performing as many RPCs as required
int pageSize = 10;
Page<Workload> singlePage = response.ReadPage(pageSize);
// Do something with the page of items
Console.WriteLine($"A page of {pageSize} results (unless it's the final page):");
foreach (Workload item in singlePage)
{
    // Do something with each item
    Console.WriteLine(item);
}
// Store the pageToken, for when the next page is required.
string nextPageToken = singlePage.NextPageToken;

ListWorkloads(string, string, int?, CallSettings)

public virtual PagedEnumerable<ListWorkloadsResponse, Workload> ListWorkloads(string parent, string pageToken = null, int? pageSize = null, CallSettings callSettings = null)

Lists customer workloads for a given customer org id

Parameters
Name Description
parent string

Required. Parent resource Format: organizations/{organization}/locations/{location}/customers/{customer}

pageToken string

The token returned from the previous request. A value of null or an empty string retrieves the first page.

pageSize int

The size of page to request. The response will not be larger than this, but may be smaller. A value of null or 0 uses a server-defined page size.

callSettings CallSettings

If not null, applies overrides to this RPC call.

Returns
Type Description
PagedEnumerableListWorkloadsResponseWorkload

A pageable sequence of Workload resources.

Example
// Create client
CloudControlsPartnerCoreClient cloudControlsPartnerCoreClient = CloudControlsPartnerCoreClient.Create();
// Initialize request argument(s)
string parent = "organizations/[ORGANIZATION]/locations/[LOCATION]/customers/[CUSTOMER]";
// Make the request
PagedEnumerable<ListWorkloadsResponse, Workload> response = cloudControlsPartnerCoreClient.ListWorkloads(parent);

// Iterate over all response items, lazily performing RPCs as required
foreach (Workload item in response)
{
    // Do something with each item
    Console.WriteLine(item);
}

// Or iterate over pages (of server-defined size), performing one RPC per page
foreach (ListWorkloadsResponse page in response.AsRawResponses())
{
    // Do something with each page of items
    Console.WriteLine("A page of results:");
    foreach (Workload item in page)
    {
        // Do something with each item
        Console.WriteLine(item);
    }
}

// Or retrieve a single page of known size (unless it's the final page), performing as many RPCs as required
int pageSize = 10;
Page<Workload> singlePage = response.ReadPage(pageSize);
// Do something with the page of items
Console.WriteLine($"A page of {pageSize} results (unless it's the final page):");
foreach (Workload item in singlePage)
{
    // Do something with each item
    Console.WriteLine(item);
}
// Store the pageToken, for when the next page is required.
string nextPageToken = singlePage.NextPageToken;

ListWorkloadsAsync(CustomerName, string, int?, CallSettings)

public virtual PagedAsyncEnumerable<ListWorkloadsResponse, Workload> ListWorkloadsAsync(CustomerName parent, string pageToken = null, int? pageSize = null, CallSettings callSettings = null)

Lists customer workloads for a given customer org id

Parameters
Name Description
parent CustomerName

Required. Parent resource Format: organizations/{organization}/locations/{location}/customers/{customer}

pageToken string

The token returned from the previous request. A value of null or an empty string retrieves the first page.

pageSize int

The size of page to request. The response will not be larger than this, but may be smaller. A value of null or 0 uses a server-defined page size.

callSettings CallSettings

If not null, applies overrides to this RPC call.

Returns
Type Description
PagedAsyncEnumerableListWorkloadsResponseWorkload

A pageable asynchronous sequence of Workload resources.

Example
// Create client
CloudControlsPartnerCoreClient cloudControlsPartnerCoreClient = await CloudControlsPartnerCoreClient.CreateAsync();
// Initialize request argument(s)
CustomerName parent = CustomerName.FromOrganizationLocationCustomer("[ORGANIZATION]", "[LOCATION]", "[CUSTOMER]");
// Make the request
PagedAsyncEnumerable<ListWorkloadsResponse, Workload> response = cloudControlsPartnerCoreClient.ListWorkloadsAsync(parent);

// Iterate over all response items, lazily performing RPCs as required
await response.ForEachAsync((Workload item) =>
{
    // Do something with each item
    Console.WriteLine(item);
});

// Or iterate over pages (of server-defined size), performing one RPC per page
await response.AsRawResponses().ForEachAsync((ListWorkloadsResponse page) =>
{
    // Do something with each page of items
    Console.WriteLine("A page of results:");
    foreach (Workload item in page)
    {
        // Do something with each item
        Console.WriteLine(item);
    }
});

// Or retrieve a single page of known size (unless it's the final page), performing as many RPCs as required
int pageSize = 10;
Page<Workload> singlePage = await response.ReadPageAsync(pageSize);
// Do something with the page of items
Console.WriteLine($"A page of {pageSize} results (unless it's the final page):");
foreach (Workload item in singlePage)
{
    // Do something with each item
    Console.WriteLine(item);
}
// Store the pageToken, for when the next page is required.
string nextPageToken = singlePage.NextPageToken;

ListWorkloadsAsync(ListWorkloadsRequest, CallSettings)

public virtual PagedAsyncEnumerable<ListWorkloadsResponse, Workload> ListWorkloadsAsync(ListWorkloadsRequest request, CallSettings callSettings = null)

Lists customer workloads for a given customer org id

Parameters
Name Description
request ListWorkloadsRequest

The request object containing all of the parameters for the API call.

callSettings CallSettings

If not null, applies overrides to this RPC call.

Returns
Type Description
PagedAsyncEnumerableListWorkloadsResponseWorkload

A pageable asynchronous sequence of Workload resources.

Example
// Create client
CloudControlsPartnerCoreClient cloudControlsPartnerCoreClient = await CloudControlsPartnerCoreClient.CreateAsync();
// Initialize request argument(s)
ListWorkloadsRequest request = new ListWorkloadsRequest
{
    ParentAsCustomerName = CustomerName.FromOrganizationLocationCustomer("[ORGANIZATION]", "[LOCATION]", "[CUSTOMER]"),
    Filter = "",
    OrderBy = "",
};
// Make the request
PagedAsyncEnumerable<ListWorkloadsResponse, Workload> response = cloudControlsPartnerCoreClient.ListWorkloadsAsync(request);

// Iterate over all response items, lazily performing RPCs as required
await response.ForEachAsync((Workload item) =>
{
    // Do something with each item
    Console.WriteLine(item);
});

// Or iterate over pages (of server-defined size), performing one RPC per page
await response.AsRawResponses().ForEachAsync((ListWorkloadsResponse page) =>
{
    // Do something with each page of items
    Console.WriteLine("A page of results:");
    foreach (Workload item in page)
    {
        // Do something with each item
        Console.WriteLine(item);
    }
});

// Or retrieve a single page of known size (unless it's the final page), performing as many RPCs as required
int pageSize = 10;
Page<Workload> singlePage = await response.ReadPageAsync(pageSize);
// Do something with the page of items
Console.WriteLine($"A page of {pageSize} results (unless it's the final page):");
foreach (Workload item in singlePage)
{
    // Do something with each item
    Console.WriteLine(item);
}
// Store the pageToken, for when the next page is required.
string nextPageToken = singlePage.NextPageToken;

ListWorkloadsAsync(string, string, int?, CallSettings)

public virtual PagedAsyncEnumerable<ListWorkloadsResponse, Workload> ListWorkloadsAsync(string parent, string pageToken = null, int? pageSize = null, CallSettings callSettings = null)

Lists customer workloads for a given customer org id

Parameters
Name Description
parent string

Required. Parent resource Format: organizations/{organization}/locations/{location}/customers/{customer}

pageToken string

The token returned from the previous request. A value of null or an empty string retrieves the first page.

pageSize int

The size of page to request. The response will not be larger than this, but may be smaller. A value of null or 0 uses a server-defined page size.

callSettings CallSettings

If not null, applies overrides to this RPC call.

Returns
Type Description
PagedAsyncEnumerableListWorkloadsResponseWorkload

A pageable asynchronous sequence of Workload resources.

Example
// Create client
CloudControlsPartnerCoreClient cloudControlsPartnerCoreClient = await CloudControlsPartnerCoreClient.CreateAsync();
// Initialize request argument(s)
string parent = "organizations/[ORGANIZATION]/locations/[LOCATION]/customers/[CUSTOMER]";
// Make the request
PagedAsyncEnumerable<ListWorkloadsResponse, Workload> response = cloudControlsPartnerCoreClient.ListWorkloadsAsync(parent);

// Iterate over all response items, lazily performing RPCs as required
await response.ForEachAsync((Workload item) =>
{
    // Do something with each item
    Console.WriteLine(item);
});

// Or iterate over pages (of server-defined size), performing one RPC per page
await response.AsRawResponses().ForEachAsync((ListWorkloadsResponse page) =>
{
    // Do something with each page of items
    Console.WriteLine("A page of results:");
    foreach (Workload item in page)
    {
        // Do something with each item
        Console.WriteLine(item);
    }
});

// Or retrieve a single page of known size (unless it's the final page), performing as many RPCs as required
int pageSize = 10;
Page<Workload> singlePage = await response.ReadPageAsync(pageSize);
// Do something with the page of items
Console.WriteLine($"A page of {pageSize} results (unless it's the final page):");
foreach (Workload item in singlePage)
{
    // Do something with each item
    Console.WriteLine(item);
}
// Store the pageToken, for when the next page is required.
string nextPageToken = singlePage.NextPageToken;

ShutdownDefaultChannelsAsync()

public static Task ShutdownDefaultChannelsAsync()

Shuts down any channels automatically created by Create() and CreateAsync(CancellationToken). Channels which weren't automatically created are not affected.

Returns
Type Description
Task

A task representing the asynchronous shutdown operation.

Remarks

After calling this method, further calls to Create() and CreateAsync(CancellationToken) will create new channels, which could in turn be shut down by another call to this method.