Class v1.CloudControlsPartnerCoreClient (0.3.1)

Version latest

• 0.3.1 (latest)
• 0.1.0

Service describing handlers for resources v1

Package

@google-cloud/cloudcontrolspartner

Constructors

(constructor)(opts, gaxInstance)

constructor(opts?: ClientOptions, gaxInstance?: typeof gax | typeof gax.fallback);

Construct an instance of CloudControlsPartnerCoreClient.

Parameters
Name	Description
opts	ClientOptions
gaxInstance	typeof gax | typeof fallback : loaded instance of google-gax. Useful if you need to avoid loading the default gRPC version and want to use the fallback HTTP implementation. Load only fallback version and pass it to the constructor: ``` const gax = require('google-gax/build/src/fallback'); // avoids loading google-gax with gRPC const client = new CloudControlsPartnerCoreClient({fallback: true}, gax); ```

Properties

apiEndpoint

get apiEndpoint(): string;

The DNS address for this API service.

apiEndpoint

static get apiEndpoint(): string;

The DNS address for this API service - same as servicePath.

auth

auth: gax.GoogleAuth;

cloudControlsPartnerCoreStub

cloudControlsPartnerCoreStub?: Promise<{
        [name: string]: Function;
    }>;

descriptors

descriptors: Descriptors;

innerApiCalls

innerApiCalls: {
        [name: string]: Function;
    };

pathTemplates

pathTemplates: {
        [name: string]: gax.PathTemplate;
    };

port

static get port(): number;

The port for this API service.

scopes

static get scopes(): string[];

The scopes needed to make gRPC calls for every method defined in this service.

servicePath

static get servicePath(): string;

The DNS address for this API service.

universeDomain

get universeDomain(): string;

warn

warn: (code: string, message: string, warnType?: string) => void;

Methods

accessApprovalRequestPath(organization, location, customer, workload, accessApprovalRequest)

accessApprovalRequestPath(organization: string, location: string, customer: string, workload: string, accessApprovalRequest: string): string;

Return a fully-qualified accessApprovalRequest resource name string.

Parameters
Name	Description
organization	string
location	string
customer	string
workload	string
accessApprovalRequest	string

Returns
Type	Description
string	{string} Resource name string.

close()

close(): Promise<void>;

Terminate the gRPC channel and close the client.

The client will no longer be usable and all future behavior is undefined.

Returns
Type	Description
Promise<void>	{Promise} A promise that resolves when the client is closed.

customerPath(organization, location, customer)

customerPath(organization: string, location: string, customer: string): string;

Return a fully-qualified customer resource name string.

Parameters
Name	Description
organization	string
location	string
customer	string

Returns
Type	Description
string	{string} Resource name string.

ekmConnectionsPath(organization, location, customer, workload)

ekmConnectionsPath(organization: string, location: string, customer: string, workload: string): string;

Return a fully-qualified ekmConnections resource name string.

Parameters
Name	Description
organization	string
location	string
customer	string
workload	string

Returns
Type	Description
string	{string} Resource name string.

getCustomer(request, options)

getCustomer(request?: protos.google.cloud.cloudcontrolspartner.v1.IGetCustomerRequest, options?: CallOptions): Promise<[
        protos.google.cloud.cloudcontrolspartner.v1.ICustomer,
        (protos.google.cloud.cloudcontrolspartner.v1.IGetCustomerRequest | undefined),
        {} | undefined
    ]>;

Gets details of a single customer

Parameters
Name	Description
request	IGetCustomerRequest The request object that will be sent.
options	CallOptions Call options. See CallOptions for more details.

Returns
Type	Description
Promise<[ protos.google.cloud.cloudcontrolspartner.v1.ICustomer, (protos.google.cloud.cloudcontrolspartner.v1.IGetCustomerRequest | undefined), {} | undefined ]>	{Promise} - The promise which resolves to an array. The first element of the array is an object representing Customer. Please see the documentation for more details and examples.

Example

  /**
   * This snippet has been automatically generated and should be regarded as a code template only.
   * It will require modifications to work.
   * It may require correct/in-range values for request initialization.
   * TODO(developer): Uncomment these variables before running the sample.
   */
  /**
   *  Required. Format:
   *  `organizations/{organization}/locations/{location}/customers/{customer}`
   */
  // const name = 'abc123'

  // Imports the Cloudcontrolspartner library
  const {CloudControlsPartnerCoreClient} = require('@google-cloud/cloudcontrolspartner').v1;

  // Instantiates a client
  const cloudcontrolspartnerClient = new CloudControlsPartnerCoreClient();

  async function callGetCustomer() {
    // Construct request
    const request = {
      name,
    };

    // Run request
    const response = await cloudcontrolspartnerClient.getCustomer(request);
    console.log(response);
  }

  callGetCustomer();

getCustomer(request, options, callback)

getCustomer(request: protos.google.cloud.cloudcontrolspartner.v1.IGetCustomerRequest, options: CallOptions, callback: Callback<protos.google.cloud.cloudcontrolspartner.v1.ICustomer, protos.google.cloud.cloudcontrolspartner.v1.IGetCustomerRequest | null | undefined, {} | null | undefined>): void;

Parameters
Name	Description
request	IGetCustomerRequest
options	CallOptions
callback	Callback<protos.google.cloud.cloudcontrolspartner.v1.ICustomer, protos.google.cloud.cloudcontrolspartner.v1.IGetCustomerRequest | null | undefined, {} | null | undefined>

Returns
Type	Description
void

getCustomer(request, callback)

getCustomer(request: protos.google.cloud.cloudcontrolspartner.v1.IGetCustomerRequest, callback: Callback<protos.google.cloud.cloudcontrolspartner.v1.ICustomer, protos.google.cloud.cloudcontrolspartner.v1.IGetCustomerRequest | null | undefined, {} | null | undefined>): void;

Parameters
Name	Description
request	IGetCustomerRequest
callback	Callback<protos.google.cloud.cloudcontrolspartner.v1.ICustomer, protos.google.cloud.cloudcontrolspartner.v1.IGetCustomerRequest | null | undefined, {} | null | undefined>

Returns
Type	Description
void

getEkmConnections(request, options)

getEkmConnections(request?: protos.google.cloud.cloudcontrolspartner.v1.IGetEkmConnectionsRequest, options?: CallOptions): Promise<[
        protos.google.cloud.cloudcontrolspartner.v1.IEkmConnections,
        (protos.google.cloud.cloudcontrolspartner.v1.IGetEkmConnectionsRequest | undefined),
        {} | undefined
    ]>;

Gets the EKM connections associated with a workload

Parameters
Name	Description
request	IGetEkmConnectionsRequest The request object that will be sent.
options	CallOptions Call options. See CallOptions for more details.

Returns
Type	Description
Promise<[ protos.google.cloud.cloudcontrolspartner.v1.IEkmConnections, (protos.google.cloud.cloudcontrolspartner.v1.IGetEkmConnectionsRequest | undefined), {} | undefined ]>	{Promise} - The promise which resolves to an array. The first element of the array is an object representing EkmConnections. Please see the documentation for more details and examples.

Example

  /**
   * This snippet has been automatically generated and should be regarded as a code template only.
   * It will require modifications to work.
   * It may require correct/in-range values for request initialization.
   * TODO(developer): Uncomment these variables before running the sample.
   */
  /**
   *  Required. Format:
   *  `organizations/{organization}/locations/{location}/customers/{customer}/workloads/{workload}/ekmConnections`
   */
  // const name = 'abc123'

  // Imports the Cloudcontrolspartner library
  const {CloudControlsPartnerCoreClient} = require('@google-cloud/cloudcontrolspartner').v1;

  // Instantiates a client
  const cloudcontrolspartnerClient = new CloudControlsPartnerCoreClient();

  async function callGetEkmConnections() {
    // Construct request
    const request = {
      name,
    };

    // Run request
    const response = await cloudcontrolspartnerClient.getEkmConnections(request);
    console.log(response);
  }

  callGetEkmConnections();

getEkmConnections(request, options, callback)

getEkmConnections(request: protos.google.cloud.cloudcontrolspartner.v1.IGetEkmConnectionsRequest, options: CallOptions, callback: Callback<protos.google.cloud.cloudcontrolspartner.v1.IEkmConnections, protos.google.cloud.cloudcontrolspartner.v1.IGetEkmConnectionsRequest | null | undefined, {} | null | undefined>): void;

Parameters
Name	Description
request	IGetEkmConnectionsRequest
options	CallOptions
callback	Callback<protos.google.cloud.cloudcontrolspartner.v1.IEkmConnections, protos.google.cloud.cloudcontrolspartner.v1.IGetEkmConnectionsRequest | null | undefined, {} | null | undefined>

Returns
Type	Description
void

getEkmConnections(request, callback)

getEkmConnections(request: protos.google.cloud.cloudcontrolspartner.v1.IGetEkmConnectionsRequest, callback: Callback<protos.google.cloud.cloudcontrolspartner.v1.IEkmConnections, protos.google.cloud.cloudcontrolspartner.v1.IGetEkmConnectionsRequest | null | undefined, {} | null | undefined>): void;

Parameters
Name	Description
request	IGetEkmConnectionsRequest
callback	Callback<protos.google.cloud.cloudcontrolspartner.v1.IEkmConnections, protos.google.cloud.cloudcontrolspartner.v1.IGetEkmConnectionsRequest | null | undefined, {} | null | undefined>

Returns
Type	Description
void

getPartner(request, options)

getPartner(request?: protos.google.cloud.cloudcontrolspartner.v1.IGetPartnerRequest, options?: CallOptions): Promise<[
        protos.google.cloud.cloudcontrolspartner.v1.IPartner,
        (protos.google.cloud.cloudcontrolspartner.v1.IGetPartnerRequest | undefined),
        {} | undefined
    ]>;

Get details of a Partner.

Parameters
Name	Description
request	IGetPartnerRequest The request object that will be sent.
options	CallOptions Call options. See CallOptions for more details.

Returns
Type	Description
Promise<[ protos.google.cloud.cloudcontrolspartner.v1.IPartner, (protos.google.cloud.cloudcontrolspartner.v1.IGetPartnerRequest | undefined), {} | undefined ]>	{Promise} - The promise which resolves to an array. The first element of the array is an object representing Partner. Please see the documentation for more details and examples.

Example

  /**
   * This snippet has been automatically generated and should be regarded as a code template only.
   * It will require modifications to work.
   * It may require correct/in-range values for request initialization.
   * TODO(developer): Uncomment these variables before running the sample.
   */
  /**
   *  Required. Format:
   *  `organizations/{organization}/locations/{location}/partner`
   */
  // const name = 'abc123'

  // Imports the Cloudcontrolspartner library
  const {CloudControlsPartnerCoreClient} = require('@google-cloud/cloudcontrolspartner').v1;

  // Instantiates a client
  const cloudcontrolspartnerClient = new CloudControlsPartnerCoreClient();

  async function callGetPartner() {
    // Construct request
    const request = {
      name,
    };

    // Run request
    const response = await cloudcontrolspartnerClient.getPartner(request);
    console.log(response);
  }

  callGetPartner();

getPartner(request, options, callback)

getPartner(request: protos.google.cloud.cloudcontrolspartner.v1.IGetPartnerRequest, options: CallOptions, callback: Callback<protos.google.cloud.cloudcontrolspartner.v1.IPartner, protos.google.cloud.cloudcontrolspartner.v1.IGetPartnerRequest | null | undefined, {} | null | undefined>): void;

Parameters
Name	Description
request	IGetPartnerRequest
options	CallOptions
callback	Callback<protos.google.cloud.cloudcontrolspartner.v1.IPartner, protos.google.cloud.cloudcontrolspartner.v1.IGetPartnerRequest | null | undefined, {} | null | undefined>

Returns
Type	Description
void

getPartner(request, callback)

getPartner(request: protos.google.cloud.cloudcontrolspartner.v1.IGetPartnerRequest, callback: Callback<protos.google.cloud.cloudcontrolspartner.v1.IPartner, protos.google.cloud.cloudcontrolspartner.v1.IGetPartnerRequest | null | undefined, {} | null | undefined>): void;

Parameters
Name	Description
request	IGetPartnerRequest
callback	Callback<protos.google.cloud.cloudcontrolspartner.v1.IPartner, protos.google.cloud.cloudcontrolspartner.v1.IGetPartnerRequest | null | undefined, {} | null | undefined>

Returns
Type	Description
void

getPartnerPermissions(request, options)

getPartnerPermissions(request?: protos.google.cloud.cloudcontrolspartner.v1.IGetPartnerPermissionsRequest, options?: CallOptions): Promise<[
        protos.google.cloud.cloudcontrolspartner.v1.IPartnerPermissions,
        (protos.google.cloud.cloudcontrolspartner.v1.IGetPartnerPermissionsRequest | undefined),
        {} | undefined
    ]>;

Gets the partner permissions granted for a workload

Parameters
Name	Description
request	IGetPartnerPermissionsRequest The request object that will be sent.
options	CallOptions Call options. See CallOptions for more details.

Returns
Type	Description
Promise<[ protos.google.cloud.cloudcontrolspartner.v1.IPartnerPermissions, (protos.google.cloud.cloudcontrolspartner.v1.IGetPartnerPermissionsRequest | undefined), {} | undefined ]>	{Promise} - The promise which resolves to an array. The first element of the array is an object representing . Please see the documentation for more details and examples.

Example

  /**
   * This snippet has been automatically generated and should be regarded as a code template only.
   * It will require modifications to work.
   * It may require correct/in-range values for request initialization.
   * TODO(developer): Uncomment these variables before running the sample.
   */
  /**
   *  Required. Name of the resource to get in the format:
   *  `organizations/{organization}/locations/{location}/customers/{customer}/workloads/{workload}/partnerPermissions`
   */
  // const name = 'abc123'

  // Imports the Cloudcontrolspartner library
  const {CloudControlsPartnerCoreClient} = require('@google-cloud/cloudcontrolspartner').v1;

  // Instantiates a client
  const cloudcontrolspartnerClient = new CloudControlsPartnerCoreClient();

  async function callGetPartnerPermissions() {
    // Construct request
    const request = {
      name,
    };

    // Run request
    const response = await cloudcontrolspartnerClient.getPartnerPermissions(request);
    console.log(response);
  }

  callGetPartnerPermissions();

getPartnerPermissions(request, options, callback)

getPartnerPermissions(request: protos.google.cloud.cloudcontrolspartner.v1.IGetPartnerPermissionsRequest, options: CallOptions, callback: Callback<protos.google.cloud.cloudcontrolspartner.v1.IPartnerPermissions, protos.google.cloud.cloudcontrolspartner.v1.IGetPartnerPermissionsRequest | null | undefined, {} | null | undefined>): void;

Parameters
Name	Description
request	IGetPartnerPermissionsRequest
options	CallOptions
callback	Callback<protos.google.cloud.cloudcontrolspartner.v1.IPartnerPermissions, protos.google.cloud.cloudcontrolspartner.v1.IGetPartnerPermissionsRequest | null | undefined, {} | null | undefined>

Returns
Type	Description
void

getPartnerPermissions(request, callback)

getPartnerPermissions(request: protos.google.cloud.cloudcontrolspartner.v1.IGetPartnerPermissionsRequest, callback: Callback<protos.google.cloud.cloudcontrolspartner.v1.IPartnerPermissions, protos.google.cloud.cloudcontrolspartner.v1.IGetPartnerPermissionsRequest | null | undefined, {} | null | undefined>): void;

Parameters
Name	Description
request	IGetPartnerPermissionsRequest
callback	Callback<protos.google.cloud.cloudcontrolspartner.v1.IPartnerPermissions, protos.google.cloud.cloudcontrolspartner.v1.IGetPartnerPermissionsRequest | null | undefined, {} | null | undefined>

Returns
Type	Description
void

getProjectId()

getProjectId(): Promise<string>;

Returns
Type	Description
Promise<string>

getProjectId(callback)

getProjectId(callback: Callback<string, undefined, undefined>): void;

Parameter
Name	Description
callback	Callback<string, undefined, undefined>

Returns
Type	Description
void

getWorkload(request, options)

getWorkload(request?: protos.google.cloud.cloudcontrolspartner.v1.IGetWorkloadRequest, options?: CallOptions): Promise<[
        protos.google.cloud.cloudcontrolspartner.v1.IWorkload,
        (protos.google.cloud.cloudcontrolspartner.v1.IGetWorkloadRequest | undefined),
        {} | undefined
    ]>;

Gets details of a single workload

Parameters
Name	Description
request	IGetWorkloadRequest The request object that will be sent.
options	CallOptions Call options. See CallOptions for more details.

Returns
Type	Description
Promise<[ protos.google.cloud.cloudcontrolspartner.v1.IWorkload, (protos.google.cloud.cloudcontrolspartner.v1.IGetWorkloadRequest | undefined), {} | undefined ]>	{Promise} - The promise which resolves to an array. The first element of the array is an object representing . Please see the documentation for more details and examples.

Example

  /**
   * This snippet has been automatically generated and should be regarded as a code template only.
   * It will require modifications to work.
   * It may require correct/in-range values for request initialization.
   * TODO(developer): Uncomment these variables before running the sample.
   */
  /**
   *  Required. Format:
   *  `organizations/{organization}/locations/{location}/customers/{customer}/workloads/{workload}`
   */
  // const name = 'abc123'

  // Imports the Cloudcontrolspartner library
  const {CloudControlsPartnerCoreClient} = require('@google-cloud/cloudcontrolspartner').v1;

  // Instantiates a client
  const cloudcontrolspartnerClient = new CloudControlsPartnerCoreClient();

  async function callGetWorkload() {
    // Construct request
    const request = {
      name,
    };

    // Run request
    const response = await cloudcontrolspartnerClient.getWorkload(request);
    console.log(response);
  }

  callGetWorkload();

getWorkload(request, options, callback)

getWorkload(request: protos.google.cloud.cloudcontrolspartner.v1.IGetWorkloadRequest, options: CallOptions, callback: Callback<protos.google.cloud.cloudcontrolspartner.v1.IWorkload, protos.google.cloud.cloudcontrolspartner.v1.IGetWorkloadRequest | null | undefined, {} | null | undefined>): void;

Parameters
Name	Description
request	IGetWorkloadRequest
options	CallOptions
callback	Callback<protos.google.cloud.cloudcontrolspartner.v1.IWorkload, protos.google.cloud.cloudcontrolspartner.v1.IGetWorkloadRequest | null | undefined, {} | null | undefined>

Returns
Type	Description
void

getWorkload(request, callback)

getWorkload(request: protos.google.cloud.cloudcontrolspartner.v1.IGetWorkloadRequest, callback: Callback<protos.google.cloud.cloudcontrolspartner.v1.IWorkload, protos.google.cloud.cloudcontrolspartner.v1.IGetWorkloadRequest | null | undefined, {} | null | undefined>): void;

Parameters
Name	Description
request	IGetWorkloadRequest
callback	Callback<protos.google.cloud.cloudcontrolspartner.v1.IWorkload, protos.google.cloud.cloudcontrolspartner.v1.IGetWorkloadRequest | null | undefined, {} | null | undefined>

Returns
Type	Description
void

initialize()

initialize(): Promise<{
        [name: string]: Function;
    }>;

Initialize the client. Performs asynchronous operations (such as authentication) and prepares the client. This function will be called automatically when any class method is called for the first time, but if you need to initialize it before calling an actual method, feel free to call initialize() directly.

You can await on this method if you want to make sure the client is initialized.

Returns
Type	Description
Promise<{ [name: string]: Function; }>	{Promise} A promise that resolves to an authenticated service stub.

listAccessApprovalRequests(request, options)

listAccessApprovalRequests(request?: protos.google.cloud.cloudcontrolspartner.v1.IListAccessApprovalRequestsRequest, options?: CallOptions): Promise<[
        protos.google.cloud.cloudcontrolspartner.v1.IAccessApprovalRequest[],
        protos.google.cloud.cloudcontrolspartner.v1.IListAccessApprovalRequestsRequest | null,
        protos.google.cloud.cloudcontrolspartner.v1.IListAccessApprovalRequestsResponse
    ]>;

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

Parameters
Name	Description
request	IListAccessApprovalRequestsRequest The request object that will be sent.
options	CallOptions Call options. See CallOptions for more details.

Returns
Type	Description
Promise<[ protos.google.cloud.cloudcontrolspartner.v1.IAccessApprovalRequest[], protos.google.cloud.cloudcontrolspartner.v1.IListAccessApprovalRequestsRequest | null, protos.google.cloud.cloudcontrolspartner.v1.IListAccessApprovalRequestsResponse ]>	{Promise} - The promise which resolves to an array. The first element of the array is Array of AccessApprovalRequest. The client library will perform auto-pagination by default: it will call the API as many times as needed and will merge results from all the pages into this array. Note that it can affect your quota. We recommend using listAccessApprovalRequestsAsync() method described below for async iteration which you can stop as needed. Please see the documentation for more details and examples.

listAccessApprovalRequests(request, options, callback)

listAccessApprovalRequests(request: protos.google.cloud.cloudcontrolspartner.v1.IListAccessApprovalRequestsRequest, options: CallOptions, callback: PaginationCallback<protos.google.cloud.cloudcontrolspartner.v1.IListAccessApprovalRequestsRequest, protos.google.cloud.cloudcontrolspartner.v1.IListAccessApprovalRequestsResponse | null | undefined, protos.google.cloud.cloudcontrolspartner.v1.IAccessApprovalRequest>): void;

Parameters
Name	Description
request	IListAccessApprovalRequestsRequest
options	CallOptions
callback	PaginationCallback<protos.google.cloud.cloudcontrolspartner.v1.IListAccessApprovalRequestsRequest, protos.google.cloud.cloudcontrolspartner.v1.IListAccessApprovalRequestsResponse | null | undefined, protos.google.cloud.cloudcontrolspartner.v1.IAccessApprovalRequest>

Returns
Type	Description
void

listAccessApprovalRequests(request, callback)

listAccessApprovalRequests(request: protos.google.cloud.cloudcontrolspartner.v1.IListAccessApprovalRequestsRequest, callback: PaginationCallback<protos.google.cloud.cloudcontrolspartner.v1.IListAccessApprovalRequestsRequest, protos.google.cloud.cloudcontrolspartner.v1.IListAccessApprovalRequestsResponse | null | undefined, protos.google.cloud.cloudcontrolspartner.v1.IAccessApprovalRequest>): void;

Parameters
Name	Description
request	IListAccessApprovalRequestsRequest
callback	PaginationCallback<protos.google.cloud.cloudcontrolspartner.v1.IListAccessApprovalRequestsRequest, protos.google.cloud.cloudcontrolspartner.v1.IListAccessApprovalRequestsResponse | null | undefined, protos.google.cloud.cloudcontrolspartner.v1.IAccessApprovalRequest>

Returns
Type	Description
void

listAccessApprovalRequestsAsync(request, options)

listAccessApprovalRequestsAsync(request?: protos.google.cloud.cloudcontrolspartner.v1.IListAccessApprovalRequestsRequest, options?: CallOptions): AsyncIterable<protos.google.cloud.cloudcontrolspartner.v1.IAccessApprovalRequest>;

Equivalent to listAccessApprovalRequests, but returns an iterable object.

for-await-of syntax is used with the iterable to get response elements on-demand.

Parameters
Name	Description
request	IListAccessApprovalRequestsRequest The request object that will be sent.
options	CallOptions Call options. See CallOptions for more details.

Returns
Type	Description
AsyncIterable<protos.google.cloud.cloudcontrolspartner.v1.IAccessApprovalRequest>	{Object} An iterable Object that allows async iteration. When you iterate the returned iterable, each element will be an object representing AccessApprovalRequest. The API will be called under the hood as needed, once per the page, so you can stop the iteration when you don't need more results. Please see the documentation for more details and examples.

Example

  /**
   * This snippet has been automatically generated and should be regarded as a code template only.
   * It will require modifications to work.
   * It may require correct/in-range values for request initialization.
   * TODO(developer): Uncomment these variables before running the sample.
   */
  /**
   *  Required. Parent resource
   *  Format:
   *  `organizations/{organization}/locations/{location}/customers/{customer}/workloads/{workload}`
   */
  // const parent = 'abc123'
  /**
   *  Optional. The maximum number of access requests to return. The service may
   *  return fewer than this value. If unspecified, at most 500 access requests
   *  will be returned.
   */
  // const pageSize = 1234
  /**
   *  Optional. A page token, received from a previous
   *  `ListAccessApprovalRequests` call. Provide this to retrieve the subsequent
   *  page.
   */
  // const pageToken = 'abc123'
  /**
   *  Optional. Filtering results.
   */
  // const filter = 'abc123'
  /**
   *  Optional. Hint for how to order the results.
   */
  // const orderBy = 'abc123'

  // Imports the Cloudcontrolspartner library
  const {CloudControlsPartnerCoreClient} = require('@google-cloud/cloudcontrolspartner').v1;

  // Instantiates a client
  const cloudcontrolspartnerClient = new CloudControlsPartnerCoreClient();

  async function callListAccessApprovalRequests() {
    // Construct request
    const request = {
      parent,
    };

    // Run request
    const iterable = cloudcontrolspartnerClient.listAccessApprovalRequestsAsync(request);
    for await (const response of iterable) {
        console.log(response);
    }
  }

  callListAccessApprovalRequests();

listAccessApprovalRequestsStream(request, options)

listAccessApprovalRequestsStream(request?: protos.google.cloud.cloudcontrolspartner.v1.IListAccessApprovalRequestsRequest, options?: CallOptions): Transform;

Equivalent to method.name.toCamelCase(), but returns a NodeJS Stream object.

Parameters
Name	Description
request	IListAccessApprovalRequestsRequest The request object that will be sent.
options	CallOptions Call options. See CallOptions for more details.

Returns
Type	Description
Transform	{Stream} An object stream which emits an object representing AccessApprovalRequest on 'data' event. The client library will perform auto-pagination by default: it will call the API as many times as needed. Note that it can affect your quota. We recommend using listAccessApprovalRequestsAsync() method described below for async iteration which you can stop as needed. Please see the documentation for more details and examples.

listCustomers(request, options)

listCustomers(request?: protos.google.cloud.cloudcontrolspartner.v1.IListCustomersRequest, options?: CallOptions): Promise<[
        protos.google.cloud.cloudcontrolspartner.v1.ICustomer[],
        protos.google.cloud.cloudcontrolspartner.v1.IListCustomersRequest | null,
        protos.google.cloud.cloudcontrolspartner.v1.IListCustomersResponse
    ]>;

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

Parameters
Name	Description
request	IListCustomersRequest The request object that will be sent.
options	CallOptions Call options. See CallOptions for more details.

Returns
Type	Description
Promise<[ protos.google.cloud.cloudcontrolspartner.v1.ICustomer[], protos.google.cloud.cloudcontrolspartner.v1.IListCustomersRequest | null, protos.google.cloud.cloudcontrolspartner.v1.IListCustomersResponse ]>	{Promise} - The promise which resolves to an array. The first element of the array is Array of Customer. The client library will perform auto-pagination by default: it will call the API as many times as needed and will merge results from all the pages into this array. Note that it can affect your quota. We recommend using listCustomersAsync() method described below for async iteration which you can stop as needed. Please see the documentation for more details and examples.

listCustomers(request, options, callback)

listCustomers(request: protos.google.cloud.cloudcontrolspartner.v1.IListCustomersRequest, options: CallOptions, callback: PaginationCallback<protos.google.cloud.cloudcontrolspartner.v1.IListCustomersRequest, protos.google.cloud.cloudcontrolspartner.v1.IListCustomersResponse | null | undefined, protos.google.cloud.cloudcontrolspartner.v1.ICustomer>): void;

Parameters
Name	Description
request	IListCustomersRequest
options	CallOptions
callback	PaginationCallback<protos.google.cloud.cloudcontrolspartner.v1.IListCustomersRequest, protos.google.cloud.cloudcontrolspartner.v1.IListCustomersResponse | null | undefined, protos.google.cloud.cloudcontrolspartner.v1.ICustomer>

Returns
Type	Description
void

listCustomers(request, callback)

listCustomers(request: protos.google.cloud.cloudcontrolspartner.v1.IListCustomersRequest, callback: PaginationCallback<protos.google.cloud.cloudcontrolspartner.v1.IListCustomersRequest, protos.google.cloud.cloudcontrolspartner.v1.IListCustomersResponse | null | undefined, protos.google.cloud.cloudcontrolspartner.v1.ICustomer>): void;

Parameters
Name	Description
request	IListCustomersRequest
callback	PaginationCallback<protos.google.cloud.cloudcontrolspartner.v1.IListCustomersRequest, protos.google.cloud.cloudcontrolspartner.v1.IListCustomersResponse | null | undefined, protos.google.cloud.cloudcontrolspartner.v1.ICustomer>

Returns
Type	Description
void

listCustomersAsync(request, options)

listCustomersAsync(request?: protos.google.cloud.cloudcontrolspartner.v1.IListCustomersRequest, options?: CallOptions): AsyncIterable<protos.google.cloud.cloudcontrolspartner.v1.ICustomer>;

Equivalent to listCustomers, but returns an iterable object.

for-await-of syntax is used with the iterable to get response elements on-demand.

Parameters
Name	Description
request	IListCustomersRequest The request object that will be sent.
options	CallOptions Call options. See CallOptions for more details.

Returns
Type	Description
AsyncIterable<protos.google.cloud.cloudcontrolspartner.v1.ICustomer>	{Object} An iterable Object that allows async iteration. When you iterate the returned iterable, each element will be an object representing Customer. The API will be called under the hood as needed, once per the page, so you can stop the iteration when you don't need more results. Please see the documentation for more details and examples.

Example

  /**
   * This snippet has been automatically generated and should be regarded as a code template only.
   * It will require modifications to work.
   * It may require correct/in-range values for request initialization.
   * TODO(developer): Uncomment these variables before running the sample.
   */
  /**
   *  Required. Parent resource
   *  Format: `organizations/{organization}/locations/{location}`
   */
  // const parent = 'abc123'
  /**
   *  The maximum number of Customers to return. The service may return fewer
   *  than this value. If unspecified, at most 500 Customers will be returned.
   */
  // const pageSize = 1234
  /**
   *  A page token, received from a previous `ListCustomers` call.
   *  Provide this to retrieve the subsequent page.
   */
  // const pageToken = 'abc123'
  /**
   *  Optional. Filtering results
   */
  // const filter = 'abc123'
  /**
   *  Optional. Hint for how to order the results
   */
  // const orderBy = 'abc123'

  // Imports the Cloudcontrolspartner library
  const {CloudControlsPartnerCoreClient} = require('@google-cloud/cloudcontrolspartner').v1;

  // Instantiates a client
  const cloudcontrolspartnerClient = new CloudControlsPartnerCoreClient();

  async function callListCustomers() {
    // Construct request
    const request = {
      parent,
    };

    // Run request
    const iterable = cloudcontrolspartnerClient.listCustomersAsync(request);
    for await (const response of iterable) {
        console.log(response);
    }
  }

  callListCustomers();

listCustomersStream(request, options)

listCustomersStream(request?: protos.google.cloud.cloudcontrolspartner.v1.IListCustomersRequest, options?: CallOptions): Transform;

Equivalent to method.name.toCamelCase(), but returns a NodeJS Stream object.

Parameters
Name	Description
request	IListCustomersRequest The request object that will be sent.
options	CallOptions Call options. See CallOptions for more details.

Returns
Type	Description
Transform	{Stream} An object stream which emits an object representing Customer on 'data' event. The client library will perform auto-pagination by default: it will call the API as many times as needed. Note that it can affect your quota. We recommend using listCustomersAsync() method described below for async iteration which you can stop as needed. Please see the documentation for more details and examples.

listWorkloads(request, options)

listWorkloads(request?: protos.google.cloud.cloudcontrolspartner.v1.IListWorkloadsRequest, options?: CallOptions): Promise<[
        protos.google.cloud.cloudcontrolspartner.v1.IWorkload[],
        protos.google.cloud.cloudcontrolspartner.v1.IListWorkloadsRequest | null,
        protos.google.cloud.cloudcontrolspartner.v1.IListWorkloadsResponse
    ]>;

Lists customer workloads for a given customer org id

Parameters
Name	Description
request	IListWorkloadsRequest The request object that will be sent.
options	CallOptions Call options. See CallOptions for more details.

Returns
Type	Description
Promise<[ protos.google.cloud.cloudcontrolspartner.v1.IWorkload[], protos.google.cloud.cloudcontrolspartner.v1.IListWorkloadsRequest | null, protos.google.cloud.cloudcontrolspartner.v1.IListWorkloadsResponse ]>	{Promise} - The promise which resolves to an array. The first element of the array is Array of . The client library will perform auto-pagination by default: it will call the API as many times as needed and will merge results from all the pages into this array. Note that it can affect your quota. We recommend using listWorkloadsAsync() method described below for async iteration which you can stop as needed. Please see the documentation for more details and examples.

listWorkloads(request, options, callback)

listWorkloads(request: protos.google.cloud.cloudcontrolspartner.v1.IListWorkloadsRequest, options: CallOptions, callback: PaginationCallback<protos.google.cloud.cloudcontrolspartner.v1.IListWorkloadsRequest, protos.google.cloud.cloudcontrolspartner.v1.IListWorkloadsResponse | null | undefined, protos.google.cloud.cloudcontrolspartner.v1.IWorkload>): void;

Parameters
Name	Description
request	IListWorkloadsRequest
options	CallOptions
callback	PaginationCallback<protos.google.cloud.cloudcontrolspartner.v1.IListWorkloadsRequest, protos.google.cloud.cloudcontrolspartner.v1.IListWorkloadsResponse | null | undefined, protos.google.cloud.cloudcontrolspartner.v1.IWorkload>

Returns
Type	Description
void

listWorkloads(request, callback)

listWorkloads(request: protos.google.cloud.cloudcontrolspartner.v1.IListWorkloadsRequest, callback: PaginationCallback<protos.google.cloud.cloudcontrolspartner.v1.IListWorkloadsRequest, protos.google.cloud.cloudcontrolspartner.v1.IListWorkloadsResponse | null | undefined, protos.google.cloud.cloudcontrolspartner.v1.IWorkload>): void;

Parameters
Name	Description
request	IListWorkloadsRequest
callback	PaginationCallback<protos.google.cloud.cloudcontrolspartner.v1.IListWorkloadsRequest, protos.google.cloud.cloudcontrolspartner.v1.IListWorkloadsResponse | null | undefined, protos.google.cloud.cloudcontrolspartner.v1.IWorkload>

Returns
Type	Description
void

listWorkloadsAsync(request, options)

listWorkloadsAsync(request?: protos.google.cloud.cloudcontrolspartner.v1.IListWorkloadsRequest, options?: CallOptions): AsyncIterable<protos.google.cloud.cloudcontrolspartner.v1.IWorkload>;

Equivalent to listWorkloads, but returns an iterable object.

for-await-of syntax is used with the iterable to get response elements on-demand.

Parameters
Name	Description
request	IListWorkloadsRequest The request object that will be sent.
options	CallOptions Call options. See CallOptions for more details.

Returns
Type	Description
AsyncIterable<protos.google.cloud.cloudcontrolspartner.v1.IWorkload>	{Object} An iterable Object that allows async iteration. When you iterate the returned iterable, each element will be an object representing . The API will be called under the hood as needed, once per the page, so you can stop the iteration when you don't need more results. Please see the documentation for more details and examples.

Example

  /**
   * This snippet has been automatically generated and should be regarded as a code template only.
   * It will require modifications to work.
   * It may require correct/in-range values for request initialization.
   * TODO(developer): Uncomment these variables before running the sample.
   */
  /**
   *  Required. Parent resource
   *  Format:
   *  `organizations/{organization}/locations/{location}/customers/{customer}`
   */
  // const parent = 'abc123'
  /**
   *  The maximum number of workloads to return. The service may return fewer
   *  than this value. If unspecified, at most 500 workloads will be returned.
   */
  // const pageSize = 1234
  /**
   *  A page token, received from a previous `ListWorkloads` call.
   *  Provide this to retrieve the subsequent page.
   */
  // const pageToken = 'abc123'
  /**
   *  Optional. Filtering results.
   */
  // const filter = 'abc123'
  /**
   *  Optional. Hint for how to order the results.
   */
  // const orderBy = 'abc123'

  // Imports the Cloudcontrolspartner library
  const {CloudControlsPartnerCoreClient} = require('@google-cloud/cloudcontrolspartner').v1;

  // Instantiates a client
  const cloudcontrolspartnerClient = new CloudControlsPartnerCoreClient();

  async function callListWorkloads() {
    // Construct request
    const request = {
      parent,
    };

    // Run request
    const iterable = cloudcontrolspartnerClient.listWorkloadsAsync(request);
    for await (const response of iterable) {
        console.log(response);
    }
  }

  callListWorkloads();

listWorkloadsStream(request, options)

listWorkloadsStream(request?: protos.google.cloud.cloudcontrolspartner.v1.IListWorkloadsRequest, options?: CallOptions): Transform;

Equivalent to method.name.toCamelCase(), but returns a NodeJS Stream object.

Parameters
Name	Description
request	IListWorkloadsRequest The request object that will be sent.
options	CallOptions Call options. See CallOptions for more details.

Returns
Type	Description
Transform	{Stream} An object stream which emits an object representing on 'data' event. The client library will perform auto-pagination by default: it will call the API as many times as needed. Note that it can affect your quota. We recommend using listWorkloadsAsync() method described below for async iteration which you can stop as needed. Please see the documentation for more details and examples.

matchAccessApprovalRequestFromAccessApprovalRequestName(accessApprovalRequestName)

matchAccessApprovalRequestFromAccessApprovalRequestName(accessApprovalRequestName: string): string | number;

Parse the access_approval_request from AccessApprovalRequest resource.

Parameter
Name	Description
accessApprovalRequestName	string A fully-qualified path representing AccessApprovalRequest resource.

Returns
Type	Description
string | number	{string} A string representing the access_approval_request.

matchCustomerFromAccessApprovalRequestName(accessApprovalRequestName)

matchCustomerFromAccessApprovalRequestName(accessApprovalRequestName: string): string | number;

Parse the customer from AccessApprovalRequest resource.

Parameter
Name	Description
accessApprovalRequestName	string A fully-qualified path representing AccessApprovalRequest resource.

Returns
Type	Description
string | number	{string} A string representing the customer.

matchCustomerFromCustomerName(customerName)

matchCustomerFromCustomerName(customerName: string): string | number;

Parse the customer from Customer resource.

Parameter
Name	Description
customerName	string A fully-qualified path representing Customer resource.

Returns
Type	Description
string | number	{string} A string representing the customer.

matchCustomerFromEkmConnectionsName(ekmConnectionsName)

matchCustomerFromEkmConnectionsName(ekmConnectionsName: string): string | number;

Parse the customer from EkmConnections resource.

Parameter
Name	Description
ekmConnectionsName	string A fully-qualified path representing EkmConnections resource.

Returns
Type	Description
string | number	{string} A string representing the customer.

matchCustomerFromPartnerPermissionsName(partnerPermissionsName)

matchCustomerFromPartnerPermissionsName(partnerPermissionsName: string): string | number;

Parse the customer from PartnerPermissions resource.

Parameter
Name	Description
partnerPermissionsName	string A fully-qualified path representing PartnerPermissions resource.

Returns
Type	Description
string | number	{string} A string representing the customer.

matchCustomerFromViolationName(violationName)

matchCustomerFromViolationName(violationName: string): string | number;

Parse the customer from Violation resource.

Parameter
Name	Description
violationName	string A fully-qualified path representing Violation resource.

Returns
Type	Description
string | number	{string} A string representing the customer.

matchCustomerFromWorkloadName(workloadName)

matchCustomerFromWorkloadName(workloadName: string): string | number;

Parse the customer from Workload resource.

Parameter
Name	Description
workloadName	string A fully-qualified path representing Workload resource.

Returns
Type	Description
string | number	{string} A string representing the customer.

matchLocationFromAccessApprovalRequestName(accessApprovalRequestName)

matchLocationFromAccessApprovalRequestName(accessApprovalRequestName: string): string | number;

Parse the location from AccessApprovalRequest resource.

Parameter
Name	Description
accessApprovalRequestName	string A fully-qualified path representing AccessApprovalRequest resource.

Returns
Type	Description
string | number	{string} A string representing the location.

matchLocationFromCustomerName(customerName)

matchLocationFromCustomerName(customerName: string): string | number;

Parse the location from Customer resource.

Parameter
Name	Description
customerName	string A fully-qualified path representing Customer resource.

Returns
Type	Description
string | number	{string} A string representing the location.

matchLocationFromEkmConnectionsName(ekmConnectionsName)

matchLocationFromEkmConnectionsName(ekmConnectionsName: string): string | number;

Parse the location from EkmConnections resource.

Parameter
Name	Description
ekmConnectionsName	string A fully-qualified path representing EkmConnections resource.

Returns
Type	Description
string | number	{string} A string representing the location.

matchLocationFromPartnerName(partnerName)

matchLocationFromPartnerName(partnerName: string): string | number;

Parse the location from Partner resource.

Parameter
Name	Description
partnerName	string A fully-qualified path representing Partner resource.

Returns
Type	Description
string | number	{string} A string representing the location.

matchLocationFromPartnerPermissionsName(partnerPermissionsName)

matchLocationFromPartnerPermissionsName(partnerPermissionsName: string): string | number;

Parse the location from PartnerPermissions resource.

Parameter
Name	Description
partnerPermissionsName	string A fully-qualified path representing PartnerPermissions resource.

Returns
Type	Description
string | number	{string} A string representing the location.

matchLocationFromViolationName(violationName)

matchLocationFromViolationName(violationName: string): string | number;

Parse the location from Violation resource.

Parameter
Name	Description
violationName	string A fully-qualified path representing Violation resource.

Returns
Type	Description
string | number	{string} A string representing the location.

matchLocationFromWorkloadName(workloadName)

matchLocationFromWorkloadName(workloadName: string): string | number;

Parse the location from Workload resource.

Parameter
Name	Description
workloadName	string A fully-qualified path representing Workload resource.

Returns
Type	Description
string | number	{string} A string representing the location.

matchOrganizationFromAccessApprovalRequestName(accessApprovalRequestName)

matchOrganizationFromAccessApprovalRequestName(accessApprovalRequestName: string): string | number;

Parse the organization from AccessApprovalRequest resource.

Parameter
Name	Description
accessApprovalRequestName	string A fully-qualified path representing AccessApprovalRequest resource.

Returns
Type	Description
string | number	{string} A string representing the organization.

matchOrganizationFromCustomerName(customerName)

matchOrganizationFromCustomerName(customerName: string): string | number;

Parse the organization from Customer resource.

Parameter
Name	Description
customerName	string A fully-qualified path representing Customer resource.

Returns
Type	Description
string | number	{string} A string representing the organization.

matchOrganizationFromEkmConnectionsName(ekmConnectionsName)

matchOrganizationFromEkmConnectionsName(ekmConnectionsName: string): string | number;

Parse the organization from EkmConnections resource.

Parameter
Name	Description
ekmConnectionsName	string A fully-qualified path representing EkmConnections resource.

Returns
Type	Description
string | number	{string} A string representing the organization.

matchOrganizationFromPartnerName(partnerName)

matchOrganizationFromPartnerName(partnerName: string): string | number;

Parse the organization from Partner resource.

Parameter
Name	Description
partnerName	string A fully-qualified path representing Partner resource.

Returns
Type	Description
string | number	{string} A string representing the organization.

matchOrganizationFromPartnerPermissionsName(partnerPermissionsName)

matchOrganizationFromPartnerPermissionsName(partnerPermissionsName: string): string | number;

Parse the organization from PartnerPermissions resource.

Parameter
Name	Description
partnerPermissionsName	string A fully-qualified path representing PartnerPermissions resource.

Returns
Type	Description
string | number	{string} A string representing the organization.

matchOrganizationFromViolationName(violationName)

matchOrganizationFromViolationName(violationName: string): string | number;

Parse the organization from Violation resource.

Parameter
Name	Description
violationName	string A fully-qualified path representing Violation resource.

Returns
Type	Description
string | number	{string} A string representing the organization.

matchOrganizationFromWorkloadName(workloadName)

matchOrganizationFromWorkloadName(workloadName: string): string | number;

Parse the organization from Workload resource.

Parameter
Name	Description
workloadName	string A fully-qualified path representing Workload resource.

Returns
Type	Description
string | number	{string} A string representing the organization.

matchViolationFromViolationName(violationName)

matchViolationFromViolationName(violationName: string): string | number;

Parse the violation from Violation resource.

Parameter
Name	Description
violationName	string A fully-qualified path representing Violation resource.

Returns
Type	Description
string | number	{string} A string representing the violation.

matchWorkloadFromAccessApprovalRequestName(accessApprovalRequestName)

matchWorkloadFromAccessApprovalRequestName(accessApprovalRequestName: string): string | number;

Parse the workload from AccessApprovalRequest resource.

Parameter
Name	Description
accessApprovalRequestName	string A fully-qualified path representing AccessApprovalRequest resource.

Returns
Type	Description
string | number	{string} A string representing the workload.

matchWorkloadFromEkmConnectionsName(ekmConnectionsName)

matchWorkloadFromEkmConnectionsName(ekmConnectionsName: string): string | number;

Parse the workload from EkmConnections resource.

Parameter
Name	Description
ekmConnectionsName	string A fully-qualified path representing EkmConnections resource.

Returns
Type	Description
string | number	{string} A string representing the workload.

matchWorkloadFromPartnerPermissionsName(partnerPermissionsName)

matchWorkloadFromPartnerPermissionsName(partnerPermissionsName: string): string | number;

Parse the workload from PartnerPermissions resource.

Parameter
Name	Description
partnerPermissionsName	string A fully-qualified path representing PartnerPermissions resource.

Returns
Type	Description
string | number	{string} A string representing the workload.

matchWorkloadFromViolationName(violationName)

matchWorkloadFromViolationName(violationName: string): string | number;

Parse the workload from Violation resource.

Parameter
Name	Description
violationName	string A fully-qualified path representing Violation resource.

Returns
Type	Description
string | number	{string} A string representing the workload.

matchWorkloadFromWorkloadName(workloadName)

matchWorkloadFromWorkloadName(workloadName: string): string | number;

Parse the workload from Workload resource.

Parameter
Name	Description
workloadName	string A fully-qualified path representing Workload resource.

Returns
Type	Description
string | number	{string} A string representing the workload.

partnerPath(organization, location)

partnerPath(organization: string, location: string): string;

Return a fully-qualified partner resource name string.

Parameters
Name	Description
organization	string
location	string

Returns
Type	Description
string	{string} Resource name string.

partnerPermissionsPath(organization, location, customer, workload)

partnerPermissionsPath(organization: string, location: string, customer: string, workload: string): string;

Return a fully-qualified partnerPermissions resource name string.

Parameters
Name	Description
organization	string
location	string
customer	string
workload	string

Returns
Type	Description
string	{string} Resource name string.

violationPath(organization, location, customer, workload, violation)

violationPath(organization: string, location: string, customer: string, workload: string, violation: string): string;

Return a fully-qualified violation resource name string.

Parameters
Name	Description
organization	string
location	string
customer	string
workload	string
violation	string

Returns
Type	Description
string	{string} Resource name string.

workloadPath(organization, location, customer, workload)

workloadPath(organization: string, location: string, customer: string, workload: string): string;

Return a fully-qualified workload resource name string.

Parameters
Name	Description
organization	string
location	string
customer	string
workload	string

Returns
Type	Description
string	{string} Resource name string.