Class v1.DeploymentClient (0.4.1)

Deployment service allows users to manage deployments of Frameworks and Cloud Controls on a target resource. v1

Package

@google-cloud/cloudsecuritycompliance

Constructors

(constructor)(opts, gaxInstance)

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

Construct an instance of DeploymentClient.

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 DeploymentClient({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;

deploymentStub

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

descriptors

descriptors: Descriptors;

innerApiCalls

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

locationsClient

locationsClient: LocationsClient;

operationsClient

operationsClient: gax.OperationsClient;

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

cancelOperation(request, optionsOrCallback, callback)

cancelOperation(request: protos.google.longrunning.CancelOperationRequest, optionsOrCallback?: gax.CallOptions | Callback<protos.google.longrunning.CancelOperationRequest, protos.google.protobuf.Empty, {} | undefined | null>, callback?: Callback<protos.google.longrunning.CancelOperationRequest, protos.google.protobuf.Empty, {} | undefined | null>): Promise<protos.google.protobuf.Empty>;

Starts asynchronous cancellation on a long-running operation. The server makes a best effort to cancel the operation, but success is not guaranteed. If the server doesn't support this method, it returns google.rpc.Code.UNIMPLEMENTED. Clients can use or other methods to check whether the cancellation succeeded or whether the operation completed despite cancellation. On successful cancellation, the operation is not deleted; instead, it becomes an operation with an value with a of 1, corresponding to Code.CANCELLED.

Parameters
Name Description
request CancelOperationRequest

The request object that will be sent.

optionsOrCallback CallOptions | Callback<protos.google.longrunning.CancelOperationRequest, protos.google.protobuf.Empty, {} | undefined | null>
callback Callback<protos.google.longrunning.CancelOperationRequest, protos.google.protobuf.Empty, {} | undefined | null>

The function which will be called with the result of the API call. {Promise} - The promise which resolves when API call finishes. The promise has a method named "cancel" which cancels the ongoing API call.

Returns
Type Description
Promise<protos.google.protobuf.Empty>
Example

const client = longrunning.operationsClient();
await client.cancelOperation({name: ''});

checkCreateFrameworkDeploymentProgress(name)

checkCreateFrameworkDeploymentProgress(name: string): Promise<LROperation<protos.google.cloud.cloudsecuritycompliance.v1.FrameworkDeployment, protos.google.cloud.cloudsecuritycompliance.v1.OperationMetadata>>;

Check the status of the long running operation returned by createFrameworkDeployment().

Parameter
Name Description
name string

The operation name that will be passed.

Returns
Type Description
Promise<LROperation<protos.google.cloud.cloudsecuritycompliance.v1.FrameworkDeployment, protos.google.cloud.cloudsecuritycompliance.v1.OperationMetadata>>

{Promise} - The promise which resolves to an object. The decoded operation object has result and metadata field to get information from. 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. The parent resource of the framework deployment in the format
   *  `organizations/{organization}/locations/{location}`
   *  or
   *  `projects/{project}/locations/{location}`.
   *  Only the global location is supported.
   */
  // const parent = 'abc123'
  /**
   *  Optional. An identifier for the framework deployment that's unique in scope
   *  of the parent. If you don't specify a value, then a random UUID is
   *  generated.
   */
  // const frameworkDeploymentId = 'abc123'
  /**
   *  Required. The framework deployment that you're creating.
   */
  // const frameworkDeployment = {}

  // Imports the Cloudsecuritycompliance library
  const {DeploymentClient} = require('@google-cloud/cloudsecuritycompliance').v1;

  // Instantiates a client
  const cloudsecuritycomplianceClient = new DeploymentClient();

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

    // Run request
    const [operation] = await cloudsecuritycomplianceClient.createFrameworkDeployment(request);
    const [response] = await operation.promise();
    console.log(response);
  }

  callCreateFrameworkDeployment();

checkDeleteFrameworkDeploymentProgress(name)

checkDeleteFrameworkDeploymentProgress(name: string): Promise<LROperation<protos.google.protobuf.Empty, protos.google.cloud.cloudsecuritycompliance.v1.OperationMetadata>>;

Check the status of the long running operation returned by deleteFrameworkDeployment().

Parameter
Name Description
name string

The operation name that will be passed.

Returns
Type Description
Promise<LROperation<protos.google.protobuf.Empty, protos.google.cloud.cloudsecuritycompliance.v1.OperationMetadata>>

{Promise} - The promise which resolves to an object. The decoded operation object has result and metadata field to get information from. 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. The name of the framework deployment that you want to delete,
   *  in the format
   *  `organizations/{organization}/locations/{location}/frameworkDeployments/{framework_deployment}`
   *  or
   *  `projects/{project}/locations/{location}/frameworkDeployments/{framework_deployment}`.
   *  The only supported location is `global`.
   */
  // const name = 'abc123'
  /**
   *  Optional. An opaque identifier for the current version of the resource.
   *  If you provide this value, then it must match the existing value. If the
   *  values don't match, then the request fails with an
   *  `ABORTED` google.rpc.Code.ABORTED  error.
   *  If you omit this value, then the resource is deleted regardless of its
   *  current `etag` value.
   */
  // const etag = 'abc123'

  // Imports the Cloudsecuritycompliance library
  const {DeploymentClient} = require('@google-cloud/cloudsecuritycompliance').v1;

  // Instantiates a client
  const cloudsecuritycomplianceClient = new DeploymentClient();

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

    // Run request
    const [operation] = await cloudsecuritycomplianceClient.deleteFrameworkDeployment(request);
    const [response] = await operation.promise();
    console.log(response);
  }

  callDeleteFrameworkDeployment();

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.

createFrameworkDeployment(request, options)

createFrameworkDeployment(request?: protos.google.cloud.cloudsecuritycompliance.v1.ICreateFrameworkDeploymentRequest, options?: CallOptions): Promise<[
        LROperation<protos.google.cloud.cloudsecuritycompliance.v1.IFrameworkDeployment, protos.google.cloud.cloudsecuritycompliance.v1.IOperationMetadata>,
        protos.google.longrunning.IOperation | undefined,
        {} | undefined
    ]>;

Creates a framework deployment in a given parent resource. A framework deployment lets you assign a particular framework version to an organization, folder, or project so that you can control and monitor those resources using the framework's cloud controls.

Parameters
Name Description
request ICreateFrameworkDeploymentRequest

The request object that will be sent.

options CallOptions

Call options. See CallOptions for more details.

Returns
Type Description
Promise<[ LROperation<protos.google.cloud.cloudsecuritycompliance.v1.IFrameworkDeployment, protos.google.cloud.cloudsecuritycompliance.v1.IOperationMetadata>, protos.google.longrunning.IOperation | undefined, {} | undefined ]>

{Promise} - The promise which resolves to an array. The first element of the array is an object representing a long running operation. Its promise() method returns a promise you can await for. 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. The parent resource of the framework deployment in the format
   *  `organizations/{organization}/locations/{location}`
   *  or
   *  `projects/{project}/locations/{location}`.
   *  Only the global location is supported.
   */
  // const parent = 'abc123'
  /**
   *  Optional. An identifier for the framework deployment that's unique in scope
   *  of the parent. If you don't specify a value, then a random UUID is
   *  generated.
   */
  // const frameworkDeploymentId = 'abc123'
  /**
   *  Required. The framework deployment that you're creating.
   */
  // const frameworkDeployment = {}

  // Imports the Cloudsecuritycompliance library
  const {DeploymentClient} = require('@google-cloud/cloudsecuritycompliance').v1;

  // Instantiates a client
  const cloudsecuritycomplianceClient = new DeploymentClient();

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

    // Run request
    const [operation] = await cloudsecuritycomplianceClient.createFrameworkDeployment(request);
    const [response] = await operation.promise();
    console.log(response);
  }

  callCreateFrameworkDeployment();

createFrameworkDeployment(request, options, callback)

createFrameworkDeployment(request: protos.google.cloud.cloudsecuritycompliance.v1.ICreateFrameworkDeploymentRequest, options: CallOptions, callback: Callback<LROperation<protos.google.cloud.cloudsecuritycompliance.v1.IFrameworkDeployment, protos.google.cloud.cloudsecuritycompliance.v1.IOperationMetadata>, protos.google.longrunning.IOperation | null | undefined, {} | null | undefined>): void;
Parameters
Name Description
request ICreateFrameworkDeploymentRequest
options CallOptions
callback Callback<LROperation<protos.google.cloud.cloudsecuritycompliance.v1.IFrameworkDeployment, protos.google.cloud.cloudsecuritycompliance.v1.IOperationMetadata>, protos.google.longrunning.IOperation | null | undefined, {} | null | undefined>
Returns
Type Description
void

createFrameworkDeployment(request, callback)

createFrameworkDeployment(request: protos.google.cloud.cloudsecuritycompliance.v1.ICreateFrameworkDeploymentRequest, callback: Callback<LROperation<protos.google.cloud.cloudsecuritycompliance.v1.IFrameworkDeployment, protos.google.cloud.cloudsecuritycompliance.v1.IOperationMetadata>, protos.google.longrunning.IOperation | null | undefined, {} | null | undefined>): void;
Parameters
Name Description
request ICreateFrameworkDeploymentRequest
callback Callback<LROperation<protos.google.cloud.cloudsecuritycompliance.v1.IFrameworkDeployment, protos.google.cloud.cloudsecuritycompliance.v1.IOperationMetadata>, protos.google.longrunning.IOperation | null | undefined, {} | null | undefined>
Returns
Type Description
void

deleteFrameworkDeployment(request, options)

deleteFrameworkDeployment(request?: protos.google.cloud.cloudsecuritycompliance.v1.IDeleteFrameworkDeploymentRequest, options?: CallOptions): Promise<[
        LROperation<protos.google.protobuf.IEmpty, protos.google.cloud.cloudsecuritycompliance.v1.IOperationMetadata>,
        protos.google.longrunning.IOperation | undefined,
        {} | undefined
    ]>;

Deletes a framework deployment.

Parameters
Name Description
request IDeleteFrameworkDeploymentRequest

The request object that will be sent.

options CallOptions

Call options. See CallOptions for more details.

Returns
Type Description
Promise<[ LROperation<protos.google.protobuf.IEmpty, protos.google.cloud.cloudsecuritycompliance.v1.IOperationMetadata>, protos.google.longrunning.IOperation | undefined, {} | undefined ]>

{Promise} - The promise which resolves to an array. The first element of the array is an object representing a long running operation. Its promise() method returns a promise you can await for. 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. The name of the framework deployment that you want to delete,
   *  in the format
   *  `organizations/{organization}/locations/{location}/frameworkDeployments/{framework_deployment}`
   *  or
   *  `projects/{project}/locations/{location}/frameworkDeployments/{framework_deployment}`.
   *  The only supported location is `global`.
   */
  // const name = 'abc123'
  /**
   *  Optional. An opaque identifier for the current version of the resource.
   *  If you provide this value, then it must match the existing value. If the
   *  values don't match, then the request fails with an
   *  `ABORTED` google.rpc.Code.ABORTED  error.
   *  If you omit this value, then the resource is deleted regardless of its
   *  current `etag` value.
   */
  // const etag = 'abc123'

  // Imports the Cloudsecuritycompliance library
  const {DeploymentClient} = require('@google-cloud/cloudsecuritycompliance').v1;

  // Instantiates a client
  const cloudsecuritycomplianceClient = new DeploymentClient();

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

    // Run request
    const [operation] = await cloudsecuritycomplianceClient.deleteFrameworkDeployment(request);
    const [response] = await operation.promise();
    console.log(response);
  }

  callDeleteFrameworkDeployment();

deleteFrameworkDeployment(request, options, callback)

deleteFrameworkDeployment(request: protos.google.cloud.cloudsecuritycompliance.v1.IDeleteFrameworkDeploymentRequest, options: CallOptions, callback: Callback<LROperation<protos.google.protobuf.IEmpty, protos.google.cloud.cloudsecuritycompliance.v1.IOperationMetadata>, protos.google.longrunning.IOperation | null | undefined, {} | null | undefined>): void;
Parameters
Name Description
request IDeleteFrameworkDeploymentRequest
options CallOptions
callback Callback<LROperation<protos.google.protobuf.IEmpty, protos.google.cloud.cloudsecuritycompliance.v1.IOperationMetadata>, protos.google.longrunning.IOperation | null | undefined, {} | null | undefined>
Returns
Type Description
void

deleteFrameworkDeployment(request, callback)

deleteFrameworkDeployment(request: protos.google.cloud.cloudsecuritycompliance.v1.IDeleteFrameworkDeploymentRequest, callback: Callback<LROperation<protos.google.protobuf.IEmpty, protos.google.cloud.cloudsecuritycompliance.v1.IOperationMetadata>, protos.google.longrunning.IOperation | null | undefined, {} | null | undefined>): void;
Parameters
Name Description
request IDeleteFrameworkDeploymentRequest
callback Callback<LROperation<protos.google.protobuf.IEmpty, protos.google.cloud.cloudsecuritycompliance.v1.IOperationMetadata>, protos.google.longrunning.IOperation | null | undefined, {} | null | undefined>
Returns
Type Description
void

deleteOperation(request, optionsOrCallback, callback)

deleteOperation(request: protos.google.longrunning.DeleteOperationRequest, optionsOrCallback?: gax.CallOptions | Callback<protos.google.protobuf.Empty, protos.google.longrunning.DeleteOperationRequest, {} | null | undefined>, callback?: Callback<protos.google.protobuf.Empty, protos.google.longrunning.DeleteOperationRequest, {} | null | undefined>): Promise<protos.google.protobuf.Empty>;

Deletes a long-running operation. This method indicates that the client is no longer interested in the operation result. It does not cancel the operation. If the server doesn't support this method, it returns google.rpc.Code.UNIMPLEMENTED.

Parameters
Name Description
request DeleteOperationRequest

The request object that will be sent.

optionsOrCallback CallOptions | Callback<protos.google.protobuf.Empty, protos.google.longrunning.DeleteOperationRequest, {} | null | undefined>
callback Callback<protos.google.protobuf.Empty, protos.google.longrunning.DeleteOperationRequest, {} | null | undefined>

The function which will be called with the result of the API call. {Promise} - The promise which resolves when API call finishes. The promise has a method named "cancel" which cancels the ongoing API call.

Returns
Type Description
Promise<protos.google.protobuf.Empty>
Example

const client = longrunning.operationsClient();
await client.deleteOperation({name: ''});

folderLocationFindingSummariesPath(folder, location, findingSummary)

folderLocationFindingSummariesPath(folder: string, location: string, findingSummary: string): string;

Return a fully-qualified folderLocationFindingSummaries resource name string.

Parameters
Name Description
folder string
location string
findingSummary string
Returns
Type Description
string

{string} Resource name string.

folderLocationFrameworkComplianceReportControlComplianceSummariesPath(folder, location, frameworkComplianceReport, controlComplianceSummary)

folderLocationFrameworkComplianceReportControlComplianceSummariesPath(folder: string, location: string, frameworkComplianceReport: string, controlComplianceSummary: string): string;

Return a fully-qualified folderLocationFrameworkComplianceReportControlComplianceSummaries resource name string.

Parameters
Name Description
folder string
location string
frameworkComplianceReport string
controlComplianceSummary string
Returns
Type Description
string

{string} Resource name string.

folderLocationFrameworkComplianceReportsPath(folder, location, frameworkComplianceReport)

folderLocationFrameworkComplianceReportsPath(folder: string, location: string, frameworkComplianceReport: string): string;

Return a fully-qualified folderLocationFrameworkComplianceReports resource name string.

Parameters
Name Description
folder string
location string
frameworkComplianceReport string
Returns
Type Description
string

{string} Resource name string.

folderLocationFrameworkComplianceSummariesPath(folder, location, frameworkComplianceSummary)

folderLocationFrameworkComplianceSummariesPath(folder: string, location: string, frameworkComplianceSummary: string): string;

Return a fully-qualified folderLocationFrameworkComplianceSummaries resource name string.

Parameters
Name Description
folder string
location string
frameworkComplianceSummary string
Returns
Type Description
string

{string} Resource name string.

getCloudControlDeployment(request, options)

getCloudControlDeployment(request?: protos.google.cloud.cloudsecuritycompliance.v1.IGetCloudControlDeploymentRequest, options?: CallOptions): Promise<[
        protos.google.cloud.cloudsecuritycompliance.v1.ICloudControlDeployment,
        (protos.google.cloud.cloudsecuritycompliance.v1.IGetCloudControlDeploymentRequest | undefined),
        {} | undefined
    ]>;

Gets details about a cloud control deployment.

Parameters
Name Description
request IGetCloudControlDeploymentRequest

The request object that will be sent.

options CallOptions

Call options. See CallOptions for more details.

Returns
Type Description
Promise<[ protos.google.cloud.cloudsecuritycompliance.v1.ICloudControlDeployment, (protos.google.cloud.cloudsecuritycompliance.v1.IGetCloudControlDeploymentRequest | undefined), {} | undefined ]>

{Promise} - The promise which resolves to an array. The first element of the array is an object representing CloudControlDeployment. 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. The name for the cloud control deployment, in the format
   *  `organizations/{organization}/locations/{location}/cloudControlDeployments/{cloud_control_deployment}`
   *  or
   *  `projects/{project}/locations/{location}/cloudControlDeployments/{cloud_control_deployment}`.
   *  The only supported location is `global`.
   */
  // const name = 'abc123'

  // Imports the Cloudsecuritycompliance library
  const {DeploymentClient} = require('@google-cloud/cloudsecuritycompliance').v1;

  // Instantiates a client
  const cloudsecuritycomplianceClient = new DeploymentClient();

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

    // Run request
    const response = await cloudsecuritycomplianceClient.getCloudControlDeployment(request);
    console.log(response);
  }

  callGetCloudControlDeployment();

getCloudControlDeployment(request, options, callback)

getCloudControlDeployment(request: protos.google.cloud.cloudsecuritycompliance.v1.IGetCloudControlDeploymentRequest, options: CallOptions, callback: Callback<protos.google.cloud.cloudsecuritycompliance.v1.ICloudControlDeployment, protos.google.cloud.cloudsecuritycompliance.v1.IGetCloudControlDeploymentRequest | null | undefined, {} | null | undefined>): void;
Parameters
Name Description
request IGetCloudControlDeploymentRequest
options CallOptions
callback Callback<protos.google.cloud.cloudsecuritycompliance.v1.ICloudControlDeployment, protos.google.cloud.cloudsecuritycompliance.v1.IGetCloudControlDeploymentRequest | null | undefined, {} | null | undefined>
Returns
Type Description
void

getCloudControlDeployment(request, callback)

getCloudControlDeployment(request: protos.google.cloud.cloudsecuritycompliance.v1.IGetCloudControlDeploymentRequest, callback: Callback<protos.google.cloud.cloudsecuritycompliance.v1.ICloudControlDeployment, protos.google.cloud.cloudsecuritycompliance.v1.IGetCloudControlDeploymentRequest | null | undefined, {} | null | undefined>): void;
Parameters
Name Description
request IGetCloudControlDeploymentRequest
callback Callback<protos.google.cloud.cloudsecuritycompliance.v1.ICloudControlDeployment, protos.google.cloud.cloudsecuritycompliance.v1.IGetCloudControlDeploymentRequest | null | undefined, {} | null | undefined>
Returns
Type Description
void

getFrameworkDeployment(request, options)

getFrameworkDeployment(request?: protos.google.cloud.cloudsecuritycompliance.v1.IGetFrameworkDeploymentRequest, options?: CallOptions): Promise<[
        protos.google.cloud.cloudsecuritycompliance.v1.IFrameworkDeployment,
        (protos.google.cloud.cloudsecuritycompliance.v1.IGetFrameworkDeploymentRequest | undefined),
        {} | undefined
    ]>;

Gets details about a framework deployment.

Parameters
Name Description
request IGetFrameworkDeploymentRequest

The request object that will be sent.

options CallOptions

Call options. See CallOptions for more details.

Returns
Type Description
Promise<[ protos.google.cloud.cloudsecuritycompliance.v1.IFrameworkDeployment, (protos.google.cloud.cloudsecuritycompliance.v1.IGetFrameworkDeploymentRequest | undefined), {} | undefined ]>

{Promise} - The promise which resolves to an array. The first element of the array is an object representing FrameworkDeployment. 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. The name of the framework deployment, in the format
   *  `organizations/{organization}/locations/{location}/frameworkDeployments/{framework_deployment}`
   *  or
   *  `projects/{project}/locations/{location}/frameworkDeployments/{framework_deployment}`.
   *  The only supported location is `global`.
   */
  // const name = 'abc123'

  // Imports the Cloudsecuritycompliance library
  const {DeploymentClient} = require('@google-cloud/cloudsecuritycompliance').v1;

  // Instantiates a client
  const cloudsecuritycomplianceClient = new DeploymentClient();

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

    // Run request
    const response = await cloudsecuritycomplianceClient.getFrameworkDeployment(request);
    console.log(response);
  }

  callGetFrameworkDeployment();

getFrameworkDeployment(request, options, callback)

getFrameworkDeployment(request: protos.google.cloud.cloudsecuritycompliance.v1.IGetFrameworkDeploymentRequest, options: CallOptions, callback: Callback<protos.google.cloud.cloudsecuritycompliance.v1.IFrameworkDeployment, protos.google.cloud.cloudsecuritycompliance.v1.IGetFrameworkDeploymentRequest | null | undefined, {} | null | undefined>): void;
Parameters
Name Description
request IGetFrameworkDeploymentRequest
options CallOptions
callback Callback<protos.google.cloud.cloudsecuritycompliance.v1.IFrameworkDeployment, protos.google.cloud.cloudsecuritycompliance.v1.IGetFrameworkDeploymentRequest | null | undefined, {} | null | undefined>
Returns
Type Description
void

getFrameworkDeployment(request, callback)

getFrameworkDeployment(request: protos.google.cloud.cloudsecuritycompliance.v1.IGetFrameworkDeploymentRequest, callback: Callback<protos.google.cloud.cloudsecuritycompliance.v1.IFrameworkDeployment, protos.google.cloud.cloudsecuritycompliance.v1.IGetFrameworkDeploymentRequest | null | undefined, {} | null | undefined>): void;
Parameters
Name Description
request IGetFrameworkDeploymentRequest
callback Callback<protos.google.cloud.cloudsecuritycompliance.v1.IFrameworkDeployment, protos.google.cloud.cloudsecuritycompliance.v1.IGetFrameworkDeploymentRequest | null | undefined, {} | null | undefined>
Returns
Type Description
void

getLocation(request, options, callback)

getLocation(request: LocationProtos.google.cloud.location.IGetLocationRequest, options?: gax.CallOptions | Callback<LocationProtos.google.cloud.location.ILocation, LocationProtos.google.cloud.location.IGetLocationRequest | null | undefined, {} | null | undefined>, callback?: Callback<LocationProtos.google.cloud.location.ILocation, LocationProtos.google.cloud.location.IGetLocationRequest | null | undefined, {} | null | undefined>): Promise<LocationProtos.google.cloud.location.ILocation>;

Gets information about a location.

Parameters
Name Description
request LocationProtos.google.cloud.location.IGetLocationRequest

The request object that will be sent.

options CallOptions | Callback<google.cloud.location.ILocation, google.cloud.location.IGetLocationRequest | null | undefined, {} | null | undefined>

Call options. See CallOptions for more details.

callback Callback<google.cloud.location.ILocation, google.cloud.location.IGetLocationRequest | null | undefined, {} | null | undefined>
Returns
Type Description
Promise<google.cloud.location.ILocation>

{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

const [response] = await client.getLocation(request);

getOperation(request, optionsOrCallback, callback)

getOperation(request: protos.google.longrunning.GetOperationRequest, optionsOrCallback?: gax.CallOptions | Callback<protos.google.longrunning.Operation, protos.google.longrunning.GetOperationRequest, {} | null | undefined>, callback?: Callback<protos.google.longrunning.Operation, protos.google.longrunning.GetOperationRequest, {} | null | undefined>): Promise<[protos.google.longrunning.Operation]>;

Gets the latest state of a long-running operation. Clients can use this method to poll the operation result at intervals as recommended by the API service.

Parameters
Name Description
request GetOperationRequest

The request object that will be sent.

optionsOrCallback CallOptions | Callback<protos.google.longrunning.Operation, protos.google.longrunning.GetOperationRequest, {} | null | undefined>
callback Callback<protos.google.longrunning.Operation, protos.google.longrunning.GetOperationRequest, {} | null | undefined>

The function which will be called with the result of the API call.

The second parameter to the callback is an object representing . {Promise} - The promise which resolves to an array. The first element of the array is an object representing . The promise has a method named "cancel" which cancels the ongoing API call.

Returns
Type Description
Promise<[protos.google.longrunning.Operation]>
Example

const client = longrunning.operationsClient();
const name = '';
const [response] = await client.getOperation({name});
// doThingsWith(response)

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

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.

listCloudControlDeployments(request, options)

listCloudControlDeployments(request?: protos.google.cloud.cloudsecuritycompliance.v1.IListCloudControlDeploymentsRequest, options?: CallOptions): Promise<[
        protos.google.cloud.cloudsecuritycompliance.v1.ICloudControlDeployment[],
        protos.google.cloud.cloudsecuritycompliance.v1.IListCloudControlDeploymentsRequest | null,
        protos.google.cloud.cloudsecuritycompliance.v1.IListCloudControlDeploymentsResponse
    ]>;

Lists the cloud conrol deployments in a given parent resource.

Parameters
Name Description
request IListCloudControlDeploymentsRequest

The request object that will be sent.

options CallOptions

Call options. See CallOptions for more details.

Returns
Type Description
Promise<[ protos.google.cloud.cloudsecuritycompliance.v1.ICloudControlDeployment[], protos.google.cloud.cloudsecuritycompliance.v1.IListCloudControlDeploymentsRequest | null, protos.google.cloud.cloudsecuritycompliance.v1.IListCloudControlDeploymentsResponse ]>

{Promise} - The promise which resolves to an array. The first element of the array is Array of CloudControlDeployment. 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 listCloudControlDeploymentsAsync() method described below for async iteration which you can stop as needed. Please see the documentation for more details and examples.

listCloudControlDeployments(request, options, callback)

listCloudControlDeployments(request: protos.google.cloud.cloudsecuritycompliance.v1.IListCloudControlDeploymentsRequest, options: CallOptions, callback: PaginationCallback<protos.google.cloud.cloudsecuritycompliance.v1.IListCloudControlDeploymentsRequest, protos.google.cloud.cloudsecuritycompliance.v1.IListCloudControlDeploymentsResponse | null | undefined, protos.google.cloud.cloudsecuritycompliance.v1.ICloudControlDeployment>): void;
Parameters
Name Description
request IListCloudControlDeploymentsRequest
options CallOptions
callback PaginationCallback<protos.google.cloud.cloudsecuritycompliance.v1.IListCloudControlDeploymentsRequest, protos.google.cloud.cloudsecuritycompliance.v1.IListCloudControlDeploymentsResponse | null | undefined, protos.google.cloud.cloudsecuritycompliance.v1.ICloudControlDeployment>
Returns
Type Description
void

listCloudControlDeployments(request, callback)

listCloudControlDeployments(request: protos.google.cloud.cloudsecuritycompliance.v1.IListCloudControlDeploymentsRequest, callback: PaginationCallback<protos.google.cloud.cloudsecuritycompliance.v1.IListCloudControlDeploymentsRequest, protos.google.cloud.cloudsecuritycompliance.v1.IListCloudControlDeploymentsResponse | null | undefined, protos.google.cloud.cloudsecuritycompliance.v1.ICloudControlDeployment>): void;
Parameters
Name Description
request IListCloudControlDeploymentsRequest
callback PaginationCallback<protos.google.cloud.cloudsecuritycompliance.v1.IListCloudControlDeploymentsRequest, protos.google.cloud.cloudsecuritycompliance.v1.IListCloudControlDeploymentsResponse | null | undefined, protos.google.cloud.cloudsecuritycompliance.v1.ICloudControlDeployment>
Returns
Type Description
void

listCloudControlDeploymentsAsync(request, options)

listCloudControlDeploymentsAsync(request?: protos.google.cloud.cloudsecuritycompliance.v1.IListCloudControlDeploymentsRequest, options?: CallOptions): AsyncIterable<protos.google.cloud.cloudsecuritycompliance.v1.ICloudControlDeployment>;

Equivalent to listCloudControlDeployments, but returns an iterable object.

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

Parameters
Name Description
request IListCloudControlDeploymentsRequest

The request object that will be sent.

options CallOptions

Call options. See CallOptions for more details.

Returns
Type Description
AsyncIterable<protos.google.cloud.cloudsecuritycompliance.v1.ICloudControlDeployment>

{Object} An iterable Object that allows async iteration. When you iterate the returned iterable, each element will be an object representing CloudControlDeployment. 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. The parent resource for the cloud control deployment, in the
   *  format `organizations/{organization}/locations/{location}` or
   *  `projects/{project}/locations/{location}`.
   *  The only supported location is `global`.
   */
  // const parent = 'abc123'
  /**
   *  Optional. The requested page size. The server might return fewer items than
   *  you requested.
   *  If unspecified, the server picks an appropriate default.
   */
  // const pageSize = 1234
  /**
   *  Optional. A token that identifies the page of results that the server
   *  should return.
   */
  // const pageToken = 'abc123'
  /**
   *  Optional. The filter to apply on the resource, as defined by
   *  AIP-160: Filtering (https://google.aip.dev/160).
   */
  // const filter = 'abc123'
  /**
   *  Optional. The sort order for the results. The following values are
   *  supported:
   *  * `name`
   *  * `name desc`
   *  If you do not specify a value, then the results are not sorted.
   */
  // const orderBy = 'abc123'

  // Imports the Cloudsecuritycompliance library
  const {DeploymentClient} = require('@google-cloud/cloudsecuritycompliance').v1;

  // Instantiates a client
  const cloudsecuritycomplianceClient = new DeploymentClient();

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

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

  callListCloudControlDeployments();

listCloudControlDeploymentsStream(request, options)

listCloudControlDeploymentsStream(request?: protos.google.cloud.cloudsecuritycompliance.v1.IListCloudControlDeploymentsRequest, options?: CallOptions): Transform;

Equivalent to listCloudControlDeployments, but returns a NodeJS Stream object.

Parameters
Name Description
request IListCloudControlDeploymentsRequest

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 CloudControlDeployment 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 listCloudControlDeploymentsAsync() method described below for async iteration which you can stop as needed. Please see the documentation for more details and examples.

listFrameworkDeployments(request, options)

listFrameworkDeployments(request?: protos.google.cloud.cloudsecuritycompliance.v1.IListFrameworkDeploymentsRequest, options?: CallOptions): Promise<[
        protos.google.cloud.cloudsecuritycompliance.v1.IFrameworkDeployment[],
        protos.google.cloud.cloudsecuritycompliance.v1.IListFrameworkDeploymentsRequest | null,
        protos.google.cloud.cloudsecuritycompliance.v1.IListFrameworkDeploymentsResponse
    ]>;

Lists the framework deployments in a given parent resource.

Parameters
Name Description
request IListFrameworkDeploymentsRequest

The request object that will be sent.

options CallOptions

Call options. See CallOptions for more details.

Returns
Type Description
Promise<[ protos.google.cloud.cloudsecuritycompliance.v1.IFrameworkDeployment[], protos.google.cloud.cloudsecuritycompliance.v1.IListFrameworkDeploymentsRequest | null, protos.google.cloud.cloudsecuritycompliance.v1.IListFrameworkDeploymentsResponse ]>

{Promise} - The promise which resolves to an array. The first element of the array is Array of FrameworkDeployment. 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 listFrameworkDeploymentsAsync() method described below for async iteration which you can stop as needed. Please see the documentation for more details and examples.

listFrameworkDeployments(request, options, callback)

listFrameworkDeployments(request: protos.google.cloud.cloudsecuritycompliance.v1.IListFrameworkDeploymentsRequest, options: CallOptions, callback: PaginationCallback<protos.google.cloud.cloudsecuritycompliance.v1.IListFrameworkDeploymentsRequest, protos.google.cloud.cloudsecuritycompliance.v1.IListFrameworkDeploymentsResponse | null | undefined, protos.google.cloud.cloudsecuritycompliance.v1.IFrameworkDeployment>): void;
Parameters
Name Description
request IListFrameworkDeploymentsRequest
options CallOptions
callback PaginationCallback<protos.google.cloud.cloudsecuritycompliance.v1.IListFrameworkDeploymentsRequest, protos.google.cloud.cloudsecuritycompliance.v1.IListFrameworkDeploymentsResponse | null | undefined, protos.google.cloud.cloudsecuritycompliance.v1.IFrameworkDeployment>
Returns
Type Description
void

listFrameworkDeployments(request, callback)

listFrameworkDeployments(request: protos.google.cloud.cloudsecuritycompliance.v1.IListFrameworkDeploymentsRequest, callback: PaginationCallback<protos.google.cloud.cloudsecuritycompliance.v1.IListFrameworkDeploymentsRequest, protos.google.cloud.cloudsecuritycompliance.v1.IListFrameworkDeploymentsResponse | null | undefined, protos.google.cloud.cloudsecuritycompliance.v1.IFrameworkDeployment>): void;
Parameters
Name Description
request IListFrameworkDeploymentsRequest
callback PaginationCallback<protos.google.cloud.cloudsecuritycompliance.v1.IListFrameworkDeploymentsRequest, protos.google.cloud.cloudsecuritycompliance.v1.IListFrameworkDeploymentsResponse | null | undefined, protos.google.cloud.cloudsecuritycompliance.v1.IFrameworkDeployment>
Returns
Type Description
void

listFrameworkDeploymentsAsync(request, options)

listFrameworkDeploymentsAsync(request?: protos.google.cloud.cloudsecuritycompliance.v1.IListFrameworkDeploymentsRequest, options?: CallOptions): AsyncIterable<protos.google.cloud.cloudsecuritycompliance.v1.IFrameworkDeployment>;

Equivalent to listFrameworkDeployments, but returns an iterable object.

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

Parameters
Name Description
request IListFrameworkDeploymentsRequest

The request object that will be sent.

options CallOptions

Call options. See CallOptions for more details.

Returns
Type Description
AsyncIterable<protos.google.cloud.cloudsecuritycompliance.v1.IFrameworkDeployment>

{Object} An iterable Object that allows async iteration. When you iterate the returned iterable, each element will be an object representing FrameworkDeployment. 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. The parent resource of the framework deployment, in the format
   *  `organizations/{organization}/locations/{location}`
   *  or
   *  `projects/{project}/locations/{location}`.
   *  The only supported location is `global`.
   */
  // const parent = 'abc123'
  /**
   *  Optional. The requested page size. The server might return fewer items than
   *  requested.
   *  If unspecified, the server picks an appropriate default.
   */
  // const pageSize = 1234
  /**
   *  Optional. A token that identifies a page of results the server should
   *  return.
   */
  // const pageToken = 'abc123'
  /**
   *  Optional. The filter to be applied on the resource, as defined by
   *  AIP-160: Filtering (https://google.aip.dev/160).
   */
  // const filter = 'abc123'
  /**
   *  Optional. The sort order for the results. The following values are
   *  supported:
   *  * `name`
   *  * `name desc`
   *  If you do not specify a value, then the results are not sorted.
   */
  // const orderBy = 'abc123'

  // Imports the Cloudsecuritycompliance library
  const {DeploymentClient} = require('@google-cloud/cloudsecuritycompliance').v1;

  // Instantiates a client
  const cloudsecuritycomplianceClient = new DeploymentClient();

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

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

  callListFrameworkDeployments();

listFrameworkDeploymentsStream(request, options)

listFrameworkDeploymentsStream(request?: protos.google.cloud.cloudsecuritycompliance.v1.IListFrameworkDeploymentsRequest, options?: CallOptions): Transform;

Equivalent to listFrameworkDeployments, but returns a NodeJS Stream object.

Parameters
Name Description
request IListFrameworkDeploymentsRequest

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 FrameworkDeployment 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 listFrameworkDeploymentsAsync() method described below for async iteration which you can stop as needed. Please see the documentation for more details and examples.

listLocationsAsync(request, options)

listLocationsAsync(request: LocationProtos.google.cloud.location.IListLocationsRequest, options?: CallOptions): AsyncIterable<LocationProtos.google.cloud.location.ILocation>;

Lists information about the supported locations for this service. Returns an iterable object.

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

Parameters
Name Description
request LocationProtos.google.cloud.location.IListLocationsRequest

The request object that will be sent.

options CallOptions

Call options. See CallOptions for more details.

Returns
Type Description
AsyncIterable<google.cloud.location.ILocation>

{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

const iterable = client.listLocationsAsync(request);
for await (const response of iterable) {
  // process response
}

listOperationsAsync(request, options)

listOperationsAsync(request: protos.google.longrunning.ListOperationsRequest, options?: gax.CallOptions): AsyncIterable<protos.google.longrunning.IOperation>;

Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns UNIMPLEMENTED. Returns an iterable object.

For-await-of syntax is used with the iterable to recursively get response element on-demand.

Parameters
Name Description
request ListOperationsRequest

The request object that will be sent.

options CallOptions

Optional parameters. You can override the default settings for this call, e.g, timeout, retries, paginations, etc. See gax.CallOptions for the details.

Returns
Type Description
AsyncIterable<protos.google.longrunning.IOperation>

{Object} An iterable Object that conforms to iteration protocols.

Example

const client = longrunning.operationsClient();
for await (const response of client.listOperationsAsync(request));
// doThingsWith(response)

matchCloudControlDeploymentFromOrganizationLocationCloudControlDeploymentsName(organizationLocationCloudControlDeploymentsName)

matchCloudControlDeploymentFromOrganizationLocationCloudControlDeploymentsName(organizationLocationCloudControlDeploymentsName: string): string | number;

Parse the cloud_control_deployment from OrganizationLocationCloudControlDeployments resource.

Parameter
Name Description
organizationLocationCloudControlDeploymentsName string

A fully-qualified path representing organization_location_cloudControlDeployments resource.

Returns
Type Description
string | number

{string} A string representing the cloud_control_deployment.

matchCloudControlDeploymentFromProjectLocationCloudControlDeploymentsName(projectLocationCloudControlDeploymentsName)

matchCloudControlDeploymentFromProjectLocationCloudControlDeploymentsName(projectLocationCloudControlDeploymentsName: string): string | number;

Parse the cloud_control_deployment from ProjectLocationCloudControlDeployments resource.

Parameter
Name Description
projectLocationCloudControlDeploymentsName string

A fully-qualified path representing project_location_cloudControlDeployments resource.

Returns
Type Description
string | number

{string} A string representing the cloud_control_deployment.

matchCloudControlFromOrganizationLocationCloudControlsName(organizationLocationCloudControlsName)

matchCloudControlFromOrganizationLocationCloudControlsName(organizationLocationCloudControlsName: string): string | number;

Parse the cloud_control from OrganizationLocationCloudControls resource.

Parameter
Name Description
organizationLocationCloudControlsName string

A fully-qualified path representing organization_location_cloudControls resource.

Returns
Type Description
string | number

{string} A string representing the cloud_control.

matchCloudControlFromProjectLocationCloudControlsName(projectLocationCloudControlsName)

matchCloudControlFromProjectLocationCloudControlsName(projectLocationCloudControlsName: string): string | number;

Parse the cloud_control from ProjectLocationCloudControls resource.

Parameter
Name Description
projectLocationCloudControlsName string

A fully-qualified path representing project_location_cloudControls resource.

Returns
Type Description
string | number

{string} A string representing the cloud_control.

matchControlComplianceSummaryFromFolderLocationFrameworkComplianceReportControlComplianceSummariesName(folderLocationFrameworkComplianceReportControlComplianceSummariesName)

matchControlComplianceSummaryFromFolderLocationFrameworkComplianceReportControlComplianceSummariesName(folderLocationFrameworkComplianceReportControlComplianceSummariesName: string): string | number;

Parse the control_compliance_summary from FolderLocationFrameworkComplianceReportControlComplianceSummaries resource.

Parameter
Name Description
folderLocationFrameworkComplianceReportControlComplianceSummariesName string

A fully-qualified path representing folder_location_framework_compliance_report_controlComplianceSummaries resource.

Returns
Type Description
string | number

{string} A string representing the control_compliance_summary.

matchControlComplianceSummaryFromOrganizationLocationFrameworkComplianceReportControlComplianceSummariesName(organizationLocationFrameworkComplianceReportControlComplianceSummariesName)

matchControlComplianceSummaryFromOrganizationLocationFrameworkComplianceReportControlComplianceSummariesName(organizationLocationFrameworkComplianceReportControlComplianceSummariesName: string): string | number;

Parse the control_compliance_summary from OrganizationLocationFrameworkComplianceReportControlComplianceSummaries resource.

Parameter
Name Description
organizationLocationFrameworkComplianceReportControlComplianceSummariesName string

A fully-qualified path representing organization_location_framework_compliance_report_controlComplianceSummaries resource.

Returns
Type Description
string | number

{string} A string representing the control_compliance_summary.

matchControlComplianceSummaryFromProjectLocationFrameworkComplianceReportControlComplianceSummariesName(projectLocationFrameworkComplianceReportControlComplianceSummariesName)

matchControlComplianceSummaryFromProjectLocationFrameworkComplianceReportControlComplianceSummariesName(projectLocationFrameworkComplianceReportControlComplianceSummariesName: string): string | number;

Parse the control_compliance_summary from ProjectLocationFrameworkComplianceReportControlComplianceSummaries resource.

Parameter
Name Description
projectLocationFrameworkComplianceReportControlComplianceSummariesName string

A fully-qualified path representing project_location_framework_compliance_report_controlComplianceSummaries resource.

Returns
Type Description
string | number

{string} A string representing the control_compliance_summary.

matchControlFromOrganizationLocationControlsName(organizationLocationControlsName)

matchControlFromOrganizationLocationControlsName(organizationLocationControlsName: string): string | number;

Parse the control from OrganizationLocationControls resource.

Parameter
Name Description
organizationLocationControlsName string

A fully-qualified path representing organization_location_controls resource.

Returns
Type Description
string | number

{string} A string representing the control.

matchControlFromProjectLocationControlsName(projectLocationControlsName)

matchControlFromProjectLocationControlsName(projectLocationControlsName: string): string | number;

Parse the control from ProjectLocationControls resource.

Parameter
Name Description
projectLocationControlsName string

A fully-qualified path representing project_location_controls resource.

Returns
Type Description
string | number

{string} A string representing the control.

matchFindingSummaryFromFolderLocationFindingSummariesName(folderLocationFindingSummariesName)

matchFindingSummaryFromFolderLocationFindingSummariesName(folderLocationFindingSummariesName: string): string | number;

Parse the finding_summary from FolderLocationFindingSummaries resource.

Parameter
Name Description
folderLocationFindingSummariesName string

A fully-qualified path representing folder_location_findingSummaries resource.

Returns
Type Description
string | number

{string} A string representing the finding_summary.

matchFindingSummaryFromOrganizationLocationFindingSummariesName(organizationLocationFindingSummariesName)

matchFindingSummaryFromOrganizationLocationFindingSummariesName(organizationLocationFindingSummariesName: string): string | number;

Parse the finding_summary from OrganizationLocationFindingSummaries resource.

Parameter
Name Description
organizationLocationFindingSummariesName string

A fully-qualified path representing organization_location_findingSummaries resource.

Returns
Type Description
string | number

{string} A string representing the finding_summary.

matchFindingSummaryFromProjectLocationFindingSummariesName(projectLocationFindingSummariesName)

matchFindingSummaryFromProjectLocationFindingSummariesName(projectLocationFindingSummariesName: string): string | number;

Parse the finding_summary from ProjectLocationFindingSummaries resource.

Parameter
Name Description
projectLocationFindingSummariesName string

A fully-qualified path representing project_location_findingSummaries resource.

Returns
Type Description
string | number

{string} A string representing the finding_summary.

matchFolderFromFolderLocationFindingSummariesName(folderLocationFindingSummariesName)

matchFolderFromFolderLocationFindingSummariesName(folderLocationFindingSummariesName: string): string | number;

Parse the folder from FolderLocationFindingSummaries resource.

Parameter
Name Description
folderLocationFindingSummariesName string

A fully-qualified path representing folder_location_findingSummaries resource.

Returns
Type Description
string | number

{string} A string representing the folder.

matchFolderFromFolderLocationFrameworkComplianceReportControlComplianceSummariesName(folderLocationFrameworkComplianceReportControlComplianceSummariesName)

matchFolderFromFolderLocationFrameworkComplianceReportControlComplianceSummariesName(folderLocationFrameworkComplianceReportControlComplianceSummariesName: string): string | number;

Parse the folder from FolderLocationFrameworkComplianceReportControlComplianceSummaries resource.

Parameter
Name Description
folderLocationFrameworkComplianceReportControlComplianceSummariesName string

A fully-qualified path representing folder_location_framework_compliance_report_controlComplianceSummaries resource.

Returns
Type Description
string | number

{string} A string representing the folder.

matchFolderFromFolderLocationFrameworkComplianceReportsName(folderLocationFrameworkComplianceReportsName)

matchFolderFromFolderLocationFrameworkComplianceReportsName(folderLocationFrameworkComplianceReportsName: string): string | number;

Parse the folder from FolderLocationFrameworkComplianceReports resource.

Parameter
Name Description
folderLocationFrameworkComplianceReportsName string

A fully-qualified path representing folder_location_frameworkComplianceReports resource.

Returns
Type Description
string | number

{string} A string representing the folder.

matchFolderFromFolderLocationFrameworkComplianceSummariesName(folderLocationFrameworkComplianceSummariesName)

matchFolderFromFolderLocationFrameworkComplianceSummariesName(folderLocationFrameworkComplianceSummariesName: string): string | number;

Parse the folder from FolderLocationFrameworkComplianceSummaries resource.

Parameter
Name Description
folderLocationFrameworkComplianceSummariesName string

A fully-qualified path representing folder_location_frameworkComplianceSummaries resource.

Returns
Type Description
string | number

{string} A string representing the folder.

matchFrameworkAuditFromOrganizationLocationFrameworkAuditsName(organizationLocationFrameworkAuditsName)

matchFrameworkAuditFromOrganizationLocationFrameworkAuditsName(organizationLocationFrameworkAuditsName: string): string | number;

Parse the framework_audit from OrganizationLocationFrameworkAudits resource.

Parameter
Name Description
organizationLocationFrameworkAuditsName string

A fully-qualified path representing organization_location_frameworkAudits resource.

Returns
Type Description
string | number

{string} A string representing the framework_audit.

matchFrameworkAuditFromProjectLocationFrameworkAuditsName(projectLocationFrameworkAuditsName)

matchFrameworkAuditFromProjectLocationFrameworkAuditsName(projectLocationFrameworkAuditsName: string): string | number;

Parse the framework_audit from ProjectLocationFrameworkAudits resource.

Parameter
Name Description
projectLocationFrameworkAuditsName string

A fully-qualified path representing project_location_frameworkAudits resource.

Returns
Type Description
string | number

{string} A string representing the framework_audit.

matchFrameworkComplianceReportFromFolderLocationFrameworkComplianceReportControlComplianceSummariesName(folderLocationFrameworkComplianceReportControlComplianceSummariesName)

matchFrameworkComplianceReportFromFolderLocationFrameworkComplianceReportControlComplianceSummariesName(folderLocationFrameworkComplianceReportControlComplianceSummariesName: string): string | number;

Parse the framework_compliance_report from FolderLocationFrameworkComplianceReportControlComplianceSummaries resource.

Parameter
Name Description
folderLocationFrameworkComplianceReportControlComplianceSummariesName string

A fully-qualified path representing folder_location_framework_compliance_report_controlComplianceSummaries resource.

Returns
Type Description
string | number

{string} A string representing the framework_compliance_report.

matchFrameworkComplianceReportFromFolderLocationFrameworkComplianceReportsName(folderLocationFrameworkComplianceReportsName)

matchFrameworkComplianceReportFromFolderLocationFrameworkComplianceReportsName(folderLocationFrameworkComplianceReportsName: string): string | number;

Parse the framework_compliance_report from FolderLocationFrameworkComplianceReports resource.

Parameter
Name Description
folderLocationFrameworkComplianceReportsName string

A fully-qualified path representing folder_location_frameworkComplianceReports resource.

Returns
Type Description
string | number

{string} A string representing the framework_compliance_report.

matchFrameworkComplianceReportFromOrganizationLocationFrameworkComplianceReportControlComplianceSummariesName(organizationLocationFrameworkComplianceReportControlComplianceSummariesName)

matchFrameworkComplianceReportFromOrganizationLocationFrameworkComplianceReportControlComplianceSummariesName(organizationLocationFrameworkComplianceReportControlComplianceSummariesName: string): string | number;

Parse the framework_compliance_report from OrganizationLocationFrameworkComplianceReportControlComplianceSummaries resource.

Parameter
Name Description
organizationLocationFrameworkComplianceReportControlComplianceSummariesName string

A fully-qualified path representing organization_location_framework_compliance_report_controlComplianceSummaries resource.

Returns
Type Description
string | number

{string} A string representing the framework_compliance_report.

matchFrameworkComplianceReportFromOrganizationLocationFrameworkComplianceReportsName(organizationLocationFrameworkComplianceReportsName)

matchFrameworkComplianceReportFromOrganizationLocationFrameworkComplianceReportsName(organizationLocationFrameworkComplianceReportsName: string): string | number;

Parse the framework_compliance_report from OrganizationLocationFrameworkComplianceReports resource.

Parameter
Name Description
organizationLocationFrameworkComplianceReportsName string

A fully-qualified path representing organization_location_frameworkComplianceReports resource.

Returns
Type Description
string | number

{string} A string representing the framework_compliance_report.

matchFrameworkComplianceReportFromProjectLocationFrameworkComplianceReportControlComplianceSummariesName(projectLocationFrameworkComplianceReportControlComplianceSummariesName)

matchFrameworkComplianceReportFromProjectLocationFrameworkComplianceReportControlComplianceSummariesName(projectLocationFrameworkComplianceReportControlComplianceSummariesName: string): string | number;

Parse the framework_compliance_report from ProjectLocationFrameworkComplianceReportControlComplianceSummaries resource.

Parameter
Name Description
projectLocationFrameworkComplianceReportControlComplianceSummariesName string

A fully-qualified path representing project_location_framework_compliance_report_controlComplianceSummaries resource.

Returns
Type Description
string | number

{string} A string representing the framework_compliance_report.

matchFrameworkComplianceReportFromProjectLocationFrameworkComplianceReportsName(projectLocationFrameworkComplianceReportsName)

matchFrameworkComplianceReportFromProjectLocationFrameworkComplianceReportsName(projectLocationFrameworkComplianceReportsName: string): string | number;

Parse the framework_compliance_report from ProjectLocationFrameworkComplianceReports resource.

Parameter
Name Description
projectLocationFrameworkComplianceReportsName string

A fully-qualified path representing project_location_frameworkComplianceReports resource.

Returns
Type Description
string | number

{string} A string representing the framework_compliance_report.

matchFrameworkComplianceSummaryFromFolderLocationFrameworkComplianceSummariesName(folderLocationFrameworkComplianceSummariesName)

matchFrameworkComplianceSummaryFromFolderLocationFrameworkComplianceSummariesName(folderLocationFrameworkComplianceSummariesName: string): string | number;

Parse the framework_compliance_summary from FolderLocationFrameworkComplianceSummaries resource.

Parameter
Name Description
folderLocationFrameworkComplianceSummariesName string

A fully-qualified path representing folder_location_frameworkComplianceSummaries resource.

Returns
Type Description
string | number

{string} A string representing the framework_compliance_summary.

matchFrameworkComplianceSummaryFromOrganizationLocationFrameworkComplianceSummariesName(organizationLocationFrameworkComplianceSummariesName)

matchFrameworkComplianceSummaryFromOrganizationLocationFrameworkComplianceSummariesName(organizationLocationFrameworkComplianceSummariesName: string): string | number;

Parse the framework_compliance_summary from OrganizationLocationFrameworkComplianceSummaries resource.

Parameter
Name Description
organizationLocationFrameworkComplianceSummariesName string

A fully-qualified path representing organization_location_frameworkComplianceSummaries resource.

Returns
Type Description
string | number

{string} A string representing the framework_compliance_summary.

matchFrameworkComplianceSummaryFromProjectLocationFrameworkComplianceSummariesName(projectLocationFrameworkComplianceSummariesName)

matchFrameworkComplianceSummaryFromProjectLocationFrameworkComplianceSummariesName(projectLocationFrameworkComplianceSummariesName: string): string | number;

Parse the framework_compliance_summary from ProjectLocationFrameworkComplianceSummaries resource.

Parameter
Name Description
projectLocationFrameworkComplianceSummariesName string

A fully-qualified path representing project_location_frameworkComplianceSummaries resource.

Returns
Type Description
string | number

{string} A string representing the framework_compliance_summary.

matchFrameworkDeploymentFromOrganizationLocationFrameworkDeploymentsName(organizationLocationFrameworkDeploymentsName)

matchFrameworkDeploymentFromOrganizationLocationFrameworkDeploymentsName(organizationLocationFrameworkDeploymentsName: string): string | number;

Parse the framework_deployment from OrganizationLocationFrameworkDeployments resource.

Parameter
Name Description
organizationLocationFrameworkDeploymentsName string

A fully-qualified path representing organization_location_frameworkDeployments resource.

Returns
Type Description
string | number

{string} A string representing the framework_deployment.

matchFrameworkDeploymentFromProjectLocationFrameworkDeploymentsName(projectLocationFrameworkDeploymentsName)

matchFrameworkDeploymentFromProjectLocationFrameworkDeploymentsName(projectLocationFrameworkDeploymentsName: string): string | number;

Parse the framework_deployment from ProjectLocationFrameworkDeployments resource.

Parameter
Name Description
projectLocationFrameworkDeploymentsName string

A fully-qualified path representing project_location_frameworkDeployments resource.

Returns
Type Description
string | number

{string} A string representing the framework_deployment.

matchFrameworkFromOrganizationLocationFrameworksName(organizationLocationFrameworksName)

matchFrameworkFromOrganizationLocationFrameworksName(organizationLocationFrameworksName: string): string | number;

Parse the framework from OrganizationLocationFrameworks resource.

Parameter
Name Description
organizationLocationFrameworksName string

A fully-qualified path representing organization_location_frameworks resource.

Returns
Type Description
string | number

{string} A string representing the framework.

matchFrameworkFromProjectLocationFrameworksName(projectLocationFrameworksName)

matchFrameworkFromProjectLocationFrameworksName(projectLocationFrameworksName: string): string | number;

Parse the framework from ProjectLocationFrameworks resource.

Parameter
Name Description
projectLocationFrameworksName string

A fully-qualified path representing project_location_frameworks resource.

Returns
Type Description
string | number

{string} A string representing the framework.

matchGenerateFrameworkAuditScopeReportResponseFromOrganizationLocationFrameworkAuditScopeReportsName(organizationLocationFrameworkAuditScopeReportsName)

matchGenerateFrameworkAuditScopeReportResponseFromOrganizationLocationFrameworkAuditScopeReportsName(organizationLocationFrameworkAuditScopeReportsName: string): string | number;

Parse the generate_framework_audit_scope_report_response from OrganizationLocationFrameworkAuditScopeReports resource.

Parameter
Name Description
organizationLocationFrameworkAuditScopeReportsName string

A fully-qualified path representing organization_location_frameworkAuditScopeReports resource.

Returns
Type Description
string | number

{string} A string representing the generate_framework_audit_scope_report_response.

matchGenerateFrameworkAuditScopeReportResponseFromProjectLocationFrameworkAuditScopeReportsName(projectLocationFrameworkAuditScopeReportsName)

matchGenerateFrameworkAuditScopeReportResponseFromProjectLocationFrameworkAuditScopeReportsName(projectLocationFrameworkAuditScopeReportsName: string): string | number;

Parse the generate_framework_audit_scope_report_response from ProjectLocationFrameworkAuditScopeReports resource.

Parameter
Name Description
projectLocationFrameworkAuditScopeReportsName string

A fully-qualified path representing project_location_frameworkAuditScopeReports resource.

Returns
Type Description
string | number

{string} A string representing the generate_framework_audit_scope_report_response.

matchLocationFromFolderLocationFindingSummariesName(folderLocationFindingSummariesName)

matchLocationFromFolderLocationFindingSummariesName(folderLocationFindingSummariesName: string): string | number;

Parse the location from FolderLocationFindingSummaries resource.

Parameter
Name Description
folderLocationFindingSummariesName string

A fully-qualified path representing folder_location_findingSummaries resource.

Returns
Type Description
string | number

{string} A string representing the location.

matchLocationFromFolderLocationFrameworkComplianceReportControlComplianceSummariesName(folderLocationFrameworkComplianceReportControlComplianceSummariesName)

matchLocationFromFolderLocationFrameworkComplianceReportControlComplianceSummariesName(folderLocationFrameworkComplianceReportControlComplianceSummariesName: string): string | number;

Parse the location from FolderLocationFrameworkComplianceReportControlComplianceSummaries resource.

Parameter
Name Description
folderLocationFrameworkComplianceReportControlComplianceSummariesName string

A fully-qualified path representing folder_location_framework_compliance_report_controlComplianceSummaries resource.

Returns
Type Description
string | number

{string} A string representing the location.

matchLocationFromFolderLocationFrameworkComplianceReportsName(folderLocationFrameworkComplianceReportsName)

matchLocationFromFolderLocationFrameworkComplianceReportsName(folderLocationFrameworkComplianceReportsName: string): string | number;

Parse the location from FolderLocationFrameworkComplianceReports resource.

Parameter
Name Description
folderLocationFrameworkComplianceReportsName string

A fully-qualified path representing folder_location_frameworkComplianceReports resource.

Returns
Type Description
string | number

{string} A string representing the location.

matchLocationFromFolderLocationFrameworkComplianceSummariesName(folderLocationFrameworkComplianceSummariesName)

matchLocationFromFolderLocationFrameworkComplianceSummariesName(folderLocationFrameworkComplianceSummariesName: string): string | number;

Parse the location from FolderLocationFrameworkComplianceSummaries resource.

Parameter
Name Description
folderLocationFrameworkComplianceSummariesName string

A fully-qualified path representing folder_location_frameworkComplianceSummaries resource.

Returns
Type Description
string | number

{string} A string representing the location.

matchLocationFromOrganizationLocationCloudControlDeploymentsName(organizationLocationCloudControlDeploymentsName)

matchLocationFromOrganizationLocationCloudControlDeploymentsName(organizationLocationCloudControlDeploymentsName: string): string | number;

Parse the location from OrganizationLocationCloudControlDeployments resource.

Parameter
Name Description
organizationLocationCloudControlDeploymentsName string

A fully-qualified path representing organization_location_cloudControlDeployments resource.

Returns
Type Description
string | number

{string} A string representing the location.

matchLocationFromOrganizationLocationCloudControlsName(organizationLocationCloudControlsName)

matchLocationFromOrganizationLocationCloudControlsName(organizationLocationCloudControlsName: string): string | number;

Parse the location from OrganizationLocationCloudControls resource.

Parameter
Name Description
organizationLocationCloudControlsName string

A fully-qualified path representing organization_location_cloudControls resource.

Returns
Type Description
string | number

{string} A string representing the location.

matchLocationFromOrganizationLocationCmEnrollmentName(organizationLocationCmEnrollmentName)

matchLocationFromOrganizationLocationCmEnrollmentName(organizationLocationCmEnrollmentName: string): string | number;

Parse the location from OrganizationLocationCmEnrollment resource.

Parameter
Name Description
organizationLocationCmEnrollmentName string

A fully-qualified path representing organization_location_cmEnrollment resource.

Returns
Type Description
string | number

{string} A string representing the location.

matchLocationFromOrganizationLocationControlsName(organizationLocationControlsName)

matchLocationFromOrganizationLocationControlsName(organizationLocationControlsName: string): string | number;

Parse the location from OrganizationLocationControls resource.

Parameter
Name Description
organizationLocationControlsName string

A fully-qualified path representing organization_location_controls resource.

Returns
Type Description
string | number

{string} A string representing the location.

matchLocationFromOrganizationLocationFindingSummariesName(organizationLocationFindingSummariesName)

matchLocationFromOrganizationLocationFindingSummariesName(organizationLocationFindingSummariesName: string): string | number;

Parse the location from OrganizationLocationFindingSummaries resource.

Parameter
Name Description
organizationLocationFindingSummariesName string

A fully-qualified path representing organization_location_findingSummaries resource.

Returns
Type Description
string | number

{string} A string representing the location.

matchLocationFromOrganizationLocationFrameworkAuditScopeReportsName(organizationLocationFrameworkAuditScopeReportsName)

matchLocationFromOrganizationLocationFrameworkAuditScopeReportsName(organizationLocationFrameworkAuditScopeReportsName: string): string | number;

Parse the location from OrganizationLocationFrameworkAuditScopeReports resource.

Parameter
Name Description
organizationLocationFrameworkAuditScopeReportsName string

A fully-qualified path representing organization_location_frameworkAuditScopeReports resource.

Returns
Type Description
string | number

{string} A string representing the location.

matchLocationFromOrganizationLocationFrameworkAuditsName(organizationLocationFrameworkAuditsName)

matchLocationFromOrganizationLocationFrameworkAuditsName(organizationLocationFrameworkAuditsName: string): string | number;

Parse the location from OrganizationLocationFrameworkAudits resource.

Parameter
Name Description
organizationLocationFrameworkAuditsName string

A fully-qualified path representing organization_location_frameworkAudits resource.

Returns
Type Description
string | number

{string} A string representing the location.

matchLocationFromOrganizationLocationFrameworkComplianceReportControlComplianceSummariesName(organizationLocationFrameworkComplianceReportControlComplianceSummariesName)

matchLocationFromOrganizationLocationFrameworkComplianceReportControlComplianceSummariesName(organizationLocationFrameworkComplianceReportControlComplianceSummariesName: string): string | number;

Parse the location from OrganizationLocationFrameworkComplianceReportControlComplianceSummaries resource.

Parameter
Name Description
organizationLocationFrameworkComplianceReportControlComplianceSummariesName string

A fully-qualified path representing organization_location_framework_compliance_report_controlComplianceSummaries resource.

Returns
Type Description
string | number

{string} A string representing the location.

matchLocationFromOrganizationLocationFrameworkComplianceReportsName(organizationLocationFrameworkComplianceReportsName)

matchLocationFromOrganizationLocationFrameworkComplianceReportsName(organizationLocationFrameworkComplianceReportsName: string): string | number;

Parse the location from OrganizationLocationFrameworkComplianceReports resource.

Parameter
Name Description
organizationLocationFrameworkComplianceReportsName string

A fully-qualified path representing organization_location_frameworkComplianceReports resource.

Returns
Type Description
string | number

{string} A string representing the location.

matchLocationFromOrganizationLocationFrameworkComplianceSummariesName(organizationLocationFrameworkComplianceSummariesName)

matchLocationFromOrganizationLocationFrameworkComplianceSummariesName(organizationLocationFrameworkComplianceSummariesName: string): string | number;

Parse the location from OrganizationLocationFrameworkComplianceSummaries resource.

Parameter
Name Description
organizationLocationFrameworkComplianceSummariesName string

A fully-qualified path representing organization_location_frameworkComplianceSummaries resource.

Returns
Type Description
string | number

{string} A string representing the location.

matchLocationFromOrganizationLocationFrameworkDeploymentsName(organizationLocationFrameworkDeploymentsName)

matchLocationFromOrganizationLocationFrameworkDeploymentsName(organizationLocationFrameworkDeploymentsName: string): string | number;

Parse the location from OrganizationLocationFrameworkDeployments resource.

Parameter
Name Description
organizationLocationFrameworkDeploymentsName string

A fully-qualified path representing organization_location_frameworkDeployments resource.

Returns
Type Description
string | number

{string} A string representing the location.

matchLocationFromOrganizationLocationFrameworksName(organizationLocationFrameworksName)

matchLocationFromOrganizationLocationFrameworksName(organizationLocationFrameworksName: string): string | number;

Parse the location from OrganizationLocationFrameworks resource.

Parameter
Name Description
organizationLocationFrameworksName string

A fully-qualified path representing organization_location_frameworks resource.

Returns
Type Description
string | number

{string} A string representing the location.

matchLocationFromOrganizationLocationName(organizationLocationName)

matchLocationFromOrganizationLocationName(organizationLocationName: string): string | number;

Parse the location from OrganizationLocation resource.

Parameter
Name Description
organizationLocationName string

A fully-qualified path representing OrganizationLocation resource.

Returns
Type Description
string | number

{string} A string representing the location.

matchLocationFromProjectLocationCloudControlDeploymentsName(projectLocationCloudControlDeploymentsName)

matchLocationFromProjectLocationCloudControlDeploymentsName(projectLocationCloudControlDeploymentsName: string): string | number;

Parse the location from ProjectLocationCloudControlDeployments resource.

Parameter
Name Description
projectLocationCloudControlDeploymentsName string

A fully-qualified path representing project_location_cloudControlDeployments resource.

Returns
Type Description
string | number

{string} A string representing the location.

matchLocationFromProjectLocationCloudControlsName(projectLocationCloudControlsName)

matchLocationFromProjectLocationCloudControlsName(projectLocationCloudControlsName: string): string | number;

Parse the location from ProjectLocationCloudControls resource.

Parameter
Name Description
projectLocationCloudControlsName string

A fully-qualified path representing project_location_cloudControls resource.

Returns
Type Description
string | number

{string} A string representing the location.

matchLocationFromProjectLocationCmEnrollmentName(projectLocationCmEnrollmentName)

matchLocationFromProjectLocationCmEnrollmentName(projectLocationCmEnrollmentName: string): string | number;

Parse the location from ProjectLocationCmEnrollment resource.

Parameter
Name Description
projectLocationCmEnrollmentName string

A fully-qualified path representing project_location_cmEnrollment resource.

Returns
Type Description
string | number

{string} A string representing the location.

matchLocationFromProjectLocationControlsName(projectLocationControlsName)

matchLocationFromProjectLocationControlsName(projectLocationControlsName: string): string | number;

Parse the location from ProjectLocationControls resource.

Parameter
Name Description
projectLocationControlsName string

A fully-qualified path representing project_location_controls resource.

Returns
Type Description
string | number

{string} A string representing the location.

matchLocationFromProjectLocationFindingSummariesName(projectLocationFindingSummariesName)

matchLocationFromProjectLocationFindingSummariesName(projectLocationFindingSummariesName: string): string | number;

Parse the location from ProjectLocationFindingSummaries resource.

Parameter
Name Description
projectLocationFindingSummariesName string

A fully-qualified path representing project_location_findingSummaries resource.

Returns
Type Description
string | number

{string} A string representing the location.

matchLocationFromProjectLocationFrameworkAuditScopeReportsName(projectLocationFrameworkAuditScopeReportsName)

matchLocationFromProjectLocationFrameworkAuditScopeReportsName(projectLocationFrameworkAuditScopeReportsName: string): string | number;

Parse the location from ProjectLocationFrameworkAuditScopeReports resource.

Parameter
Name Description
projectLocationFrameworkAuditScopeReportsName string

A fully-qualified path representing project_location_frameworkAuditScopeReports resource.

Returns
Type Description
string | number

{string} A string representing the location.

matchLocationFromProjectLocationFrameworkAuditsName(projectLocationFrameworkAuditsName)

matchLocationFromProjectLocationFrameworkAuditsName(projectLocationFrameworkAuditsName: string): string | number;

Parse the location from ProjectLocationFrameworkAudits resource.

Parameter
Name Description
projectLocationFrameworkAuditsName string

A fully-qualified path representing project_location_frameworkAudits resource.

Returns
Type Description
string | number

{string} A string representing the location.

matchLocationFromProjectLocationFrameworkComplianceReportControlComplianceSummariesName(projectLocationFrameworkComplianceReportControlComplianceSummariesName)

matchLocationFromProjectLocationFrameworkComplianceReportControlComplianceSummariesName(projectLocationFrameworkComplianceReportControlComplianceSummariesName: string): string | number;

Parse the location from ProjectLocationFrameworkComplianceReportControlComplianceSummaries resource.

Parameter
Name Description
projectLocationFrameworkComplianceReportControlComplianceSummariesName string

A fully-qualified path representing project_location_framework_compliance_report_controlComplianceSummaries resource.

Returns
Type Description
string | number

{string} A string representing the location.

matchLocationFromProjectLocationFrameworkComplianceReportsName(projectLocationFrameworkComplianceReportsName)

matchLocationFromProjectLocationFrameworkComplianceReportsName(projectLocationFrameworkComplianceReportsName: string): string | number;

Parse the location from ProjectLocationFrameworkComplianceReports resource.

Parameter
Name Description
projectLocationFrameworkComplianceReportsName string

A fully-qualified path representing project_location_frameworkComplianceReports resource.

Returns
Type Description
string | number

{string} A string representing the location.

matchLocationFromProjectLocationFrameworkComplianceSummariesName(projectLocationFrameworkComplianceSummariesName)

matchLocationFromProjectLocationFrameworkComplianceSummariesName(projectLocationFrameworkComplianceSummariesName: string): string | number;

Parse the location from ProjectLocationFrameworkComplianceSummaries resource.

Parameter
Name Description
projectLocationFrameworkComplianceSummariesName string

A fully-qualified path representing project_location_frameworkComplianceSummaries resource.

Returns
Type Description
string | number

{string} A string representing the location.

matchLocationFromProjectLocationFrameworkDeploymentsName(projectLocationFrameworkDeploymentsName)

matchLocationFromProjectLocationFrameworkDeploymentsName(projectLocationFrameworkDeploymentsName: string): string | number;

Parse the location from ProjectLocationFrameworkDeployments resource.

Parameter
Name Description
projectLocationFrameworkDeploymentsName string

A fully-qualified path representing project_location_frameworkDeployments resource.

Returns
Type Description
string | number

{string} A string representing the location.

matchLocationFromProjectLocationFrameworksName(projectLocationFrameworksName)

matchLocationFromProjectLocationFrameworksName(projectLocationFrameworksName: string): string | number;

Parse the location from ProjectLocationFrameworks resource.

Parameter
Name Description
projectLocationFrameworksName string

A fully-qualified path representing project_location_frameworks resource.

Returns
Type Description
string | number

{string} A string representing the location.

matchOrganizationFromOrganizationLocationCloudControlDeploymentsName(organizationLocationCloudControlDeploymentsName)

matchOrganizationFromOrganizationLocationCloudControlDeploymentsName(organizationLocationCloudControlDeploymentsName: string): string | number;

Parse the organization from OrganizationLocationCloudControlDeployments resource.

Parameter
Name Description
organizationLocationCloudControlDeploymentsName string

A fully-qualified path representing organization_location_cloudControlDeployments resource.

Returns
Type Description
string | number

{string} A string representing the organization.

matchOrganizationFromOrganizationLocationCloudControlsName(organizationLocationCloudControlsName)

matchOrganizationFromOrganizationLocationCloudControlsName(organizationLocationCloudControlsName: string): string | number;

Parse the organization from OrganizationLocationCloudControls resource.

Parameter
Name Description
organizationLocationCloudControlsName string

A fully-qualified path representing organization_location_cloudControls resource.

Returns
Type Description
string | number

{string} A string representing the organization.

matchOrganizationFromOrganizationLocationCmEnrollmentName(organizationLocationCmEnrollmentName)

matchOrganizationFromOrganizationLocationCmEnrollmentName(organizationLocationCmEnrollmentName: string): string | number;

Parse the organization from OrganizationLocationCmEnrollment resource.

Parameter
Name Description
organizationLocationCmEnrollmentName string

A fully-qualified path representing organization_location_cmEnrollment resource.

Returns
Type Description
string | number

{string} A string representing the organization.

matchOrganizationFromOrganizationLocationControlsName(organizationLocationControlsName)

matchOrganizationFromOrganizationLocationControlsName(organizationLocationControlsName: string): string | number;

Parse the organization from OrganizationLocationControls resource.

Parameter
Name Description
organizationLocationControlsName string

A fully-qualified path representing organization_location_controls resource.

Returns
Type Description
string | number

{string} A string representing the organization.

matchOrganizationFromOrganizationLocationFindingSummariesName(organizationLocationFindingSummariesName)

matchOrganizationFromOrganizationLocationFindingSummariesName(organizationLocationFindingSummariesName: string): string | number;

Parse the organization from OrganizationLocationFindingSummaries resource.

Parameter
Name Description
organizationLocationFindingSummariesName string

A fully-qualified path representing organization_location_findingSummaries resource.

Returns
Type Description
string | number

{string} A string representing the organization.

matchOrganizationFromOrganizationLocationFrameworkAuditScopeReportsName(organizationLocationFrameworkAuditScopeReportsName)

matchOrganizationFromOrganizationLocationFrameworkAuditScopeReportsName(organizationLocationFrameworkAuditScopeReportsName: string): string | number;

Parse the organization from OrganizationLocationFrameworkAuditScopeReports resource.

Parameter
Name Description
organizationLocationFrameworkAuditScopeReportsName string

A fully-qualified path representing organization_location_frameworkAuditScopeReports resource.

Returns
Type Description
string | number

{string} A string representing the organization.

matchOrganizationFromOrganizationLocationFrameworkAuditsName(organizationLocationFrameworkAuditsName)

matchOrganizationFromOrganizationLocationFrameworkAuditsName(organizationLocationFrameworkAuditsName: string): string | number;

Parse the organization from OrganizationLocationFrameworkAudits resource.

Parameter
Name Description
organizationLocationFrameworkAuditsName string

A fully-qualified path representing organization_location_frameworkAudits resource.

Returns
Type Description
string | number

{string} A string representing the organization.

matchOrganizationFromOrganizationLocationFrameworkComplianceReportControlComplianceSummariesName(organizationLocationFrameworkComplianceReportControlComplianceSummariesName)

matchOrganizationFromOrganizationLocationFrameworkComplianceReportControlComplianceSummariesName(organizationLocationFrameworkComplianceReportControlComplianceSummariesName: string): string | number;

Parse the organization from OrganizationLocationFrameworkComplianceReportControlComplianceSummaries resource.

Parameter
Name Description
organizationLocationFrameworkComplianceReportControlComplianceSummariesName string

A fully-qualified path representing organization_location_framework_compliance_report_controlComplianceSummaries resource.

Returns
Type Description
string | number

{string} A string representing the organization.

matchOrganizationFromOrganizationLocationFrameworkComplianceReportsName(organizationLocationFrameworkComplianceReportsName)

matchOrganizationFromOrganizationLocationFrameworkComplianceReportsName(organizationLocationFrameworkComplianceReportsName: string): string | number;

Parse the organization from OrganizationLocationFrameworkComplianceReports resource.

Parameter
Name Description
organizationLocationFrameworkComplianceReportsName string

A fully-qualified path representing organization_location_frameworkComplianceReports resource.

Returns
Type Description
string | number

{string} A string representing the organization.

matchOrganizationFromOrganizationLocationFrameworkComplianceSummariesName(organizationLocationFrameworkComplianceSummariesName)

matchOrganizationFromOrganizationLocationFrameworkComplianceSummariesName(organizationLocationFrameworkComplianceSummariesName: string): string | number;

Parse the organization from OrganizationLocationFrameworkComplianceSummaries resource.

Parameter
Name Description
organizationLocationFrameworkComplianceSummariesName string

A fully-qualified path representing organization_location_frameworkComplianceSummaries resource.

Returns
Type Description
string | number

{string} A string representing the organization.

matchOrganizationFromOrganizationLocationFrameworkDeploymentsName(organizationLocationFrameworkDeploymentsName)

matchOrganizationFromOrganizationLocationFrameworkDeploymentsName(organizationLocationFrameworkDeploymentsName: string): string | number;

Parse the organization from OrganizationLocationFrameworkDeployments resource.

Parameter
Name Description
organizationLocationFrameworkDeploymentsName string

A fully-qualified path representing organization_location_frameworkDeployments resource.

Returns
Type Description
string | number

{string} A string representing the organization.

matchOrganizationFromOrganizationLocationFrameworksName(organizationLocationFrameworksName)

matchOrganizationFromOrganizationLocationFrameworksName(organizationLocationFrameworksName: string): string | number;

Parse the organization from OrganizationLocationFrameworks resource.

Parameter
Name Description
organizationLocationFrameworksName string

A fully-qualified path representing organization_location_frameworks resource.

Returns
Type Description
string | number

{string} A string representing the organization.

matchOrganizationFromOrganizationLocationName(organizationLocationName)

matchOrganizationFromOrganizationLocationName(organizationLocationName: string): string | number;

Parse the organization from OrganizationLocation resource.

Parameter
Name Description
organizationLocationName string

A fully-qualified path representing OrganizationLocation resource.

Returns
Type Description
string | number

{string} A string representing the organization.

matchOrganizationFromOrganizationName(organizationName)

matchOrganizationFromOrganizationName(organizationName: string): string | number;

Parse the organization from Organization resource.

Parameter
Name Description
organizationName string

A fully-qualified path representing Organization resource.

Returns
Type Description
string | number

{string} A string representing the organization.

matchProjectFromProjectLocationCloudControlDeploymentsName(projectLocationCloudControlDeploymentsName)

matchProjectFromProjectLocationCloudControlDeploymentsName(projectLocationCloudControlDeploymentsName: string): string | number;

Parse the project from ProjectLocationCloudControlDeployments resource.

Parameter
Name Description
projectLocationCloudControlDeploymentsName string

A fully-qualified path representing project_location_cloudControlDeployments resource.

Returns
Type Description
string | number

{string} A string representing the project.

matchProjectFromProjectLocationCloudControlsName(projectLocationCloudControlsName)

matchProjectFromProjectLocationCloudControlsName(projectLocationCloudControlsName: string): string | number;

Parse the project from ProjectLocationCloudControls resource.

Parameter
Name Description
projectLocationCloudControlsName string

A fully-qualified path representing project_location_cloudControls resource.

Returns
Type Description
string | number

{string} A string representing the project.

matchProjectFromProjectLocationCmEnrollmentName(projectLocationCmEnrollmentName)

matchProjectFromProjectLocationCmEnrollmentName(projectLocationCmEnrollmentName: string): string | number;

Parse the project from ProjectLocationCmEnrollment resource.

Parameter
Name Description
projectLocationCmEnrollmentName string

A fully-qualified path representing project_location_cmEnrollment resource.

Returns
Type Description
string | number

{string} A string representing the project.

matchProjectFromProjectLocationControlsName(projectLocationControlsName)

matchProjectFromProjectLocationControlsName(projectLocationControlsName: string): string | number;

Parse the project from ProjectLocationControls resource.

Parameter
Name Description
projectLocationControlsName string

A fully-qualified path representing project_location_controls resource.

Returns
Type Description
string | number

{string} A string representing the project.

matchProjectFromProjectLocationFindingSummariesName(projectLocationFindingSummariesName)

matchProjectFromProjectLocationFindingSummariesName(projectLocationFindingSummariesName: string): string | number;

Parse the project from ProjectLocationFindingSummaries resource.

Parameter
Name Description
projectLocationFindingSummariesName string

A fully-qualified path representing project_location_findingSummaries resource.

Returns
Type Description
string | number

{string} A string representing the project.

matchProjectFromProjectLocationFrameworkAuditScopeReportsName(projectLocationFrameworkAuditScopeReportsName)

matchProjectFromProjectLocationFrameworkAuditScopeReportsName(projectLocationFrameworkAuditScopeReportsName: string): string | number;

Parse the project from ProjectLocationFrameworkAuditScopeReports resource.

Parameter
Name Description
projectLocationFrameworkAuditScopeReportsName string

A fully-qualified path representing project_location_frameworkAuditScopeReports resource.

Returns
Type Description
string | number

{string} A string representing the project.

matchProjectFromProjectLocationFrameworkAuditsName(projectLocationFrameworkAuditsName)

matchProjectFromProjectLocationFrameworkAuditsName(projectLocationFrameworkAuditsName: string): string | number;

Parse the project from ProjectLocationFrameworkAudits resource.

Parameter
Name Description
projectLocationFrameworkAuditsName string

A fully-qualified path representing project_location_frameworkAudits resource.

Returns
Type Description
string | number

{string} A string representing the project.

matchProjectFromProjectLocationFrameworkComplianceReportControlComplianceSummariesName(projectLocationFrameworkComplianceReportControlComplianceSummariesName)

matchProjectFromProjectLocationFrameworkComplianceReportControlComplianceSummariesName(projectLocationFrameworkComplianceReportControlComplianceSummariesName: string): string | number;

Parse the project from ProjectLocationFrameworkComplianceReportControlComplianceSummaries resource.

Parameter
Name Description
projectLocationFrameworkComplianceReportControlComplianceSummariesName string

A fully-qualified path representing project_location_framework_compliance_report_controlComplianceSummaries resource.

Returns
Type Description
string | number

{string} A string representing the project.

matchProjectFromProjectLocationFrameworkComplianceReportsName(projectLocationFrameworkComplianceReportsName)

matchProjectFromProjectLocationFrameworkComplianceReportsName(projectLocationFrameworkComplianceReportsName: string): string | number;

Parse the project from ProjectLocationFrameworkComplianceReports resource.

Parameter
Name Description
projectLocationFrameworkComplianceReportsName string

A fully-qualified path representing project_location_frameworkComplianceReports resource.

Returns
Type Description
string | number

{string} A string representing the project.

matchProjectFromProjectLocationFrameworkComplianceSummariesName(projectLocationFrameworkComplianceSummariesName)

matchProjectFromProjectLocationFrameworkComplianceSummariesName(projectLocationFrameworkComplianceSummariesName: string): string | number;

Parse the project from ProjectLocationFrameworkComplianceSummaries resource.

Parameter
Name Description
projectLocationFrameworkComplianceSummariesName string

A fully-qualified path representing project_location_frameworkComplianceSummaries resource.

Returns
Type Description
string | number

{string} A string representing the project.

matchProjectFromProjectLocationFrameworkDeploymentsName(projectLocationFrameworkDeploymentsName)

matchProjectFromProjectLocationFrameworkDeploymentsName(projectLocationFrameworkDeploymentsName: string): string | number;

Parse the project from ProjectLocationFrameworkDeployments resource.

Parameter
Name Description
projectLocationFrameworkDeploymentsName string

A fully-qualified path representing project_location_frameworkDeployments resource.

Returns
Type Description
string | number

{string} A string representing the project.

matchProjectFromProjectLocationFrameworksName(projectLocationFrameworksName)

matchProjectFromProjectLocationFrameworksName(projectLocationFrameworksName: string): string | number;

Parse the project from ProjectLocationFrameworks resource.

Parameter
Name Description
projectLocationFrameworksName string

A fully-qualified path representing project_location_frameworks resource.

Returns
Type Description
string | number

{string} A string representing the project.

organizationLocationCloudControlDeploymentsPath(organization, location, cloudControlDeployment)

organizationLocationCloudControlDeploymentsPath(organization: string, location: string, cloudControlDeployment: string): string;

Return a fully-qualified organizationLocationCloudControlDeployments resource name string.

Parameters
Name Description
organization string
location string
cloudControlDeployment string
Returns
Type Description
string

{string} Resource name string.

organizationLocationCloudControlsPath(organization, location, cloudControl)

organizationLocationCloudControlsPath(organization: string, location: string, cloudControl: string): string;

Return a fully-qualified organizationLocationCloudControls resource name string.

Parameters
Name Description
organization string
location string
cloudControl string
Returns
Type Description
string

{string} Resource name string.

organizationLocationCmEnrollmentPath(organization, location)

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

Return a fully-qualified organizationLocationCmEnrollment resource name string.

Parameters
Name Description
organization string
location string
Returns
Type Description
string

{string} Resource name string.

organizationLocationControlsPath(organization, location, control)

organizationLocationControlsPath(organization: string, location: string, control: string): string;

Return a fully-qualified organizationLocationControls resource name string.

Parameters
Name Description
organization string
location string
control string
Returns
Type Description
string

{string} Resource name string.

organizationLocationFindingSummariesPath(organization, location, findingSummary)

organizationLocationFindingSummariesPath(organization: string, location: string, findingSummary: string): string;

Return a fully-qualified organizationLocationFindingSummaries resource name string.

Parameters
Name Description
organization string
location string
findingSummary string
Returns
Type Description
string

{string} Resource name string.

organizationLocationFrameworkAuditScopeReportsPath(organization, location, generateFrameworkAuditScopeReportResponse)

organizationLocationFrameworkAuditScopeReportsPath(organization: string, location: string, generateFrameworkAuditScopeReportResponse: string): string;

Return a fully-qualified organizationLocationFrameworkAuditScopeReports resource name string.

Parameters
Name Description
organization string
location string
generateFrameworkAuditScopeReportResponse string
Returns
Type Description
string

{string} Resource name string.

organizationLocationFrameworkAuditsPath(organization, location, frameworkAudit)

organizationLocationFrameworkAuditsPath(organization: string, location: string, frameworkAudit: string): string;

Return a fully-qualified organizationLocationFrameworkAudits resource name string.

Parameters
Name Description
organization string
location string
frameworkAudit string
Returns
Type Description
string

{string} Resource name string.

organizationLocationFrameworkComplianceReportControlComplianceSummariesPath(organization, location, frameworkComplianceReport, controlComplianceSummary)

organizationLocationFrameworkComplianceReportControlComplianceSummariesPath(organization: string, location: string, frameworkComplianceReport: string, controlComplianceSummary: string): string;

Return a fully-qualified organizationLocationFrameworkComplianceReportControlComplianceSummaries resource name string.

Parameters
Name Description
organization string
location string
frameworkComplianceReport string
controlComplianceSummary string
Returns
Type Description
string

{string} Resource name string.

organizationLocationFrameworkComplianceReportsPath(organization, location, frameworkComplianceReport)

organizationLocationFrameworkComplianceReportsPath(organization: string, location: string, frameworkComplianceReport: string): string;

Return a fully-qualified organizationLocationFrameworkComplianceReports resource name string.

Parameters
Name Description
organization string
location string
frameworkComplianceReport string
Returns
Type Description
string

{string} Resource name string.

organizationLocationFrameworkComplianceSummariesPath(organization, location, frameworkComplianceSummary)

organizationLocationFrameworkComplianceSummariesPath(organization: string, location: string, frameworkComplianceSummary: string): string;

Return a fully-qualified organizationLocationFrameworkComplianceSummaries resource name string.

Parameters
Name Description
organization string
location string
frameworkComplianceSummary string
Returns
Type Description
string

{string} Resource name string.

organizationLocationFrameworkDeploymentsPath(organization, location, frameworkDeployment)

organizationLocationFrameworkDeploymentsPath(organization: string, location: string, frameworkDeployment: string): string;

Return a fully-qualified organizationLocationFrameworkDeployments resource name string.

Parameters
Name Description
organization string
location string
frameworkDeployment string
Returns
Type Description
string

{string} Resource name string.

organizationLocationFrameworksPath(organization, location, framework)

organizationLocationFrameworksPath(organization: string, location: string, framework: string): string;

Return a fully-qualified organizationLocationFrameworks resource name string.

Parameters
Name Description
organization string
location string
framework string
Returns
Type Description
string

{string} Resource name string.

organizationLocationPath(organization, location)

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

Return a fully-qualified organizationLocation resource name string.

Parameters
Name Description
organization string
location string
Returns
Type Description
string

{string} Resource name string.

organizationPath(organization)

organizationPath(organization: string): string;

Return a fully-qualified organization resource name string.

Parameter
Name Description
organization string
Returns
Type Description
string

{string} Resource name string.

projectLocationCloudControlDeploymentsPath(project, location, cloudControlDeployment)

projectLocationCloudControlDeploymentsPath(project: string, location: string, cloudControlDeployment: string): string;

Return a fully-qualified projectLocationCloudControlDeployments resource name string.

Parameters
Name Description
project string
location string
cloudControlDeployment string
Returns
Type Description
string

{string} Resource name string.

projectLocationCloudControlsPath(project, location, cloudControl)

projectLocationCloudControlsPath(project: string, location: string, cloudControl: string): string;

Return a fully-qualified projectLocationCloudControls resource name string.

Parameters
Name Description
project string
location string
cloudControl string
Returns
Type Description
string

{string} Resource name string.

projectLocationCmEnrollmentPath(project, location)

projectLocationCmEnrollmentPath(project: string, location: string): string;

Return a fully-qualified projectLocationCmEnrollment resource name string.

Parameters
Name Description
project string
location string
Returns
Type Description
string

{string} Resource name string.

projectLocationControlsPath(project, location, control)

projectLocationControlsPath(project: string, location: string, control: string): string;

Return a fully-qualified projectLocationControls resource name string.

Parameters
Name Description
project string
location string
control string
Returns
Type Description
string

{string} Resource name string.

projectLocationFindingSummariesPath(project, location, findingSummary)

projectLocationFindingSummariesPath(project: string, location: string, findingSummary: string): string;

Return a fully-qualified projectLocationFindingSummaries resource name string.

Parameters
Name Description
project string
location string
findingSummary string
Returns
Type Description
string

{string} Resource name string.

projectLocationFrameworkAuditScopeReportsPath(project, location, generateFrameworkAuditScopeReportResponse)

projectLocationFrameworkAuditScopeReportsPath(project: string, location: string, generateFrameworkAuditScopeReportResponse: string): string;

Return a fully-qualified projectLocationFrameworkAuditScopeReports resource name string.

Parameters
Name Description
project string
location string
generateFrameworkAuditScopeReportResponse string
Returns
Type Description
string

{string} Resource name string.

projectLocationFrameworkAuditsPath(project, location, frameworkAudit)

projectLocationFrameworkAuditsPath(project: string, location: string, frameworkAudit: string): string;

Return a fully-qualified projectLocationFrameworkAudits resource name string.

Parameters
Name Description
project string
location string
frameworkAudit string
Returns
Type Description
string

{string} Resource name string.

projectLocationFrameworkComplianceReportControlComplianceSummariesPath(project, location, frameworkComplianceReport, controlComplianceSummary)

projectLocationFrameworkComplianceReportControlComplianceSummariesPath(project: string, location: string, frameworkComplianceReport: string, controlComplianceSummary: string): string;

Return a fully-qualified projectLocationFrameworkComplianceReportControlComplianceSummaries resource name string.

Parameters
Name Description
project string
location string
frameworkComplianceReport string
controlComplianceSummary string
Returns
Type Description
string

{string} Resource name string.

projectLocationFrameworkComplianceReportsPath(project, location, frameworkComplianceReport)

projectLocationFrameworkComplianceReportsPath(project: string, location: string, frameworkComplianceReport: string): string;

Return a fully-qualified projectLocationFrameworkComplianceReports resource name string.

Parameters
Name Description
project string
location string
frameworkComplianceReport string
Returns
Type Description
string

{string} Resource name string.

projectLocationFrameworkComplianceSummariesPath(project, location, frameworkComplianceSummary)

projectLocationFrameworkComplianceSummariesPath(project: string, location: string, frameworkComplianceSummary: string): string;

Return a fully-qualified projectLocationFrameworkComplianceSummaries resource name string.

Parameters
Name Description
project string
location string
frameworkComplianceSummary string
Returns
Type Description
string

{string} Resource name string.

projectLocationFrameworkDeploymentsPath(project, location, frameworkDeployment)

projectLocationFrameworkDeploymentsPath(project: string, location: string, frameworkDeployment: string): string;

Return a fully-qualified projectLocationFrameworkDeployments resource name string.

Parameters
Name Description
project string
location string
frameworkDeployment string
Returns
Type Description
string

{string} Resource name string.

projectLocationFrameworksPath(project, location, framework)

projectLocationFrameworksPath(project: string, location: string, framework: string): string;

Return a fully-qualified projectLocationFrameworks resource name string.

Parameters
Name Description
project string
location string
framework string
Returns
Type Description
string

{string} Resource name string.