Class v1.SimulatorClient (0.6.0)

Version latest

• 0.6.0 (latest)
• 0.5.1

Policy Simulator API service.

Policy Simulator is a collection of endpoints for creating, running, and viewing a . A is a type of simulation that lets you see how your principals' access to resources might change if you changed your IAM policy.

During a , Policy Simulator re-evaluates, or replays, past access attempts under both the current policy and your proposed policy, and compares those results to determine how your principals' access might change under the proposed policy. v1

Package

@google-cloud/policysimulator

Constructors

(constructor)(opts, gaxInstance)

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

Construct an instance of SimulatorClient.

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

descriptors

descriptors: Descriptors;

innerApiCalls

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

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.

simulatorStub

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

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: ''});

checkCreateReplayProgress(name)

checkCreateReplayProgress(name: string): Promise<LROperation<protos.google.cloud.policysimulator.v1.Replay, protos.google.cloud.policysimulator.v1.ReplayOperationMetadata>>;

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

Parameter
Name	Description
name	string The operation name that will be passed.

Returns
Type	Description
Promise<LROperation<protos.google.cloud.policysimulator.v1.Replay, protos.google.cloud.policysimulator.v1.ReplayOperationMetadata>>	{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 where this
   *  Replay google.cloud.policysimulator.v1.Replay  will be created. This
   *  resource must be a project, folder, or organization with a location.
   *  Example: `projects/my-example-project/locations/global`
   */
  // const parent = 'abc123'
  /**
   *  Required. The Replay google.cloud.policysimulator.v1.Replay  to create.
   *  Set `Replay.ReplayConfig` to configure the replay.
   */
  // const replay = {}

  // Imports the Policysimulator library
  const {SimulatorClient} = require('@google-cloud/policysimulator').v1;

  // Instantiates a client
  const policysimulatorClient = new SimulatorClient();

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

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

  callCreateReplay();

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.

createReplay(request, options)

createReplay(request?: protos.google.cloud.policysimulator.v1.ICreateReplayRequest, options?: CallOptions): Promise<[
        LROperation<protos.google.cloud.policysimulator.v1.IReplay, protos.google.cloud.policysimulator.v1.IReplayOperationMetadata>,
        protos.google.longrunning.IOperation | undefined,
        {} | undefined
    ]>;

Creates and starts a using the given .

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

Returns
Type	Description
Promise<[ LROperation<protos.google.cloud.policysimulator.v1.IReplay, protos.google.cloud.policysimulator.v1.IReplayOperationMetadata>, 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 where this
   *  Replay google.cloud.policysimulator.v1.Replay  will be created. This
   *  resource must be a project, folder, or organization with a location.
   *  Example: `projects/my-example-project/locations/global`
   */
  // const parent = 'abc123'
  /**
   *  Required. The Replay google.cloud.policysimulator.v1.Replay  to create.
   *  Set `Replay.ReplayConfig` to configure the replay.
   */
  // const replay = {}

  // Imports the Policysimulator library
  const {SimulatorClient} = require('@google-cloud/policysimulator').v1;

  // Instantiates a client
  const policysimulatorClient = new SimulatorClient();

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

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

  callCreateReplay();

createReplay(request, options, callback)

createReplay(request: protos.google.cloud.policysimulator.v1.ICreateReplayRequest, options: CallOptions, callback: Callback<LROperation<protos.google.cloud.policysimulator.v1.IReplay, protos.google.cloud.policysimulator.v1.IReplayOperationMetadata>, protos.google.longrunning.IOperation | null | undefined, {} | null | undefined>): void;

Parameters
Name	Description
request	ICreateReplayRequest
options	CallOptions
callback	Callback<LROperation<protos.google.cloud.policysimulator.v1.IReplay, protos.google.cloud.policysimulator.v1.IReplayOperationMetadata>, protos.google.longrunning.IOperation | null | undefined, {} | null | undefined>

Returns
Type	Description
void

createReplay(request, callback)

createReplay(request: protos.google.cloud.policysimulator.v1.ICreateReplayRequest, callback: Callback<LROperation<protos.google.cloud.policysimulator.v1.IReplay, protos.google.cloud.policysimulator.v1.IReplayOperationMetadata>, protos.google.longrunning.IOperation | null | undefined, {} | null | undefined>): void;

Parameters
Name	Description
request	ICreateReplayRequest
callback	Callback<LROperation<protos.google.cloud.policysimulator.v1.IReplay, protos.google.cloud.policysimulator.v1.IReplayOperationMetadata>, 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: ''});

folderLocationReplayPath(folder, location, replay)

folderLocationReplayPath(folder: string, location: string, replay: string): string;

Return a fully-qualified folderLocationReplay resource name string.

Parameters
Name	Description
folder	string
location	string
replay	string

Returns
Type	Description
string	{string} Resource name string.

folderLocationReplayReplayResultPath(folder, location, replay, replayResult)

folderLocationReplayReplayResultPath(folder: string, location: string, replay: string, replayResult: string): string;

Return a fully-qualified folderLocationReplayReplayResult resource name string.

Parameters
Name	Description
folder	string
location	string
replay	string
replayResult	string

Returns
Type	Description
string	{string} Resource name string.

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

getReplay(request, options)

getReplay(request?: protos.google.cloud.policysimulator.v1.IGetReplayRequest, options?: CallOptions): Promise<[
        protos.google.cloud.policysimulator.v1.IReplay,
        protos.google.cloud.policysimulator.v1.IGetReplayRequest | undefined,
        {} | undefined
    ]>;

Gets the specified . Each Replay is available for at least 7 days.

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

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

Example

  /**
   * This snippet has been automatically generated and should be regarded as a code template only.
   * It will require modifications to work.
   * It may require correct/in-range values for request initialization.
   * TODO(developer): Uncomment these variables before running the sample.
   */
  /**
   *  Required. The name of the Replay google.cloud.policysimulator.v1.Replay 
   *  to retrieve, in the following format:
   *  `{projects|folders|organizations}/{resource-id}/locations/global/replays/{replay-id}`,
   *  where `{resource-id}` is the ID of the project, folder, or organization
   *  that owns the `Replay`.
   *  Example:
   *  `projects/my-example-project/locations/global/replays/506a5f7f-38ce-4d7d-8e03-479ce1833c36`
   */
  // const name = 'abc123'

  // Imports the Policysimulator library
  const {SimulatorClient} = require('@google-cloud/policysimulator').v1;

  // Instantiates a client
  const policysimulatorClient = new SimulatorClient();

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

    // Run request
    const response = await policysimulatorClient.getReplay(request);
    console.log(response);
  }

  callGetReplay();

getReplay(request, options, callback)

getReplay(request: protos.google.cloud.policysimulator.v1.IGetReplayRequest, options: CallOptions, callback: Callback<protos.google.cloud.policysimulator.v1.IReplay, protos.google.cloud.policysimulator.v1.IGetReplayRequest | null | undefined, {} | null | undefined>): void;

Parameters
Name	Description
request	IGetReplayRequest
options	CallOptions
callback	Callback<protos.google.cloud.policysimulator.v1.IReplay, protos.google.cloud.policysimulator.v1.IGetReplayRequest | null | undefined, {} | null | undefined>

Returns
Type	Description
void

getReplay(request, callback)

getReplay(request: protos.google.cloud.policysimulator.v1.IGetReplayRequest, callback: Callback<protos.google.cloud.policysimulator.v1.IReplay, protos.google.cloud.policysimulator.v1.IGetReplayRequest | null | undefined, {} | null | undefined>): void;

Parameters
Name	Description
request	IGetReplayRequest
callback	Callback<protos.google.cloud.policysimulator.v1.IReplay, protos.google.cloud.policysimulator.v1.IGetReplayRequest | null | undefined, {} | null | undefined>

Returns
Type	Description
void

initialize()

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

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

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

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

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)

listReplayResults(request, options)

listReplayResults(request?: protos.google.cloud.policysimulator.v1.IListReplayResultsRequest, options?: CallOptions): Promise<[
        protos.google.cloud.policysimulator.v1.IReplayResult[],
        protos.google.cloud.policysimulator.v1.IListReplayResultsRequest | null,
        protos.google.cloud.policysimulator.v1.IListReplayResultsResponse
    ]>;

Lists the results of running a .

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

Returns
Type	Description
Promise<[ protos.google.cloud.policysimulator.v1.IReplayResult[], protos.google.cloud.policysimulator.v1.IListReplayResultsRequest | null, protos.google.cloud.policysimulator.v1.IListReplayResultsResponse ]>	{Promise} - The promise which resolves to an array. The first element of the array is Array of ReplayResult. 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 listReplayResultsAsync() method described below for async iteration which you can stop as needed. Please see the documentation for more details and examples.

listReplayResults(request, options, callback)

listReplayResults(request: protos.google.cloud.policysimulator.v1.IListReplayResultsRequest, options: CallOptions, callback: PaginationCallback<protos.google.cloud.policysimulator.v1.IListReplayResultsRequest, protos.google.cloud.policysimulator.v1.IListReplayResultsResponse | null | undefined, protos.google.cloud.policysimulator.v1.IReplayResult>): void;

Parameters
Name	Description
request	IListReplayResultsRequest
options	CallOptions
callback	PaginationCallback<protos.google.cloud.policysimulator.v1.IListReplayResultsRequest, protos.google.cloud.policysimulator.v1.IListReplayResultsResponse | null | undefined, protos.google.cloud.policysimulator.v1.IReplayResult>

Returns
Type	Description
void

listReplayResults(request, callback)

listReplayResults(request: protos.google.cloud.policysimulator.v1.IListReplayResultsRequest, callback: PaginationCallback<protos.google.cloud.policysimulator.v1.IListReplayResultsRequest, protos.google.cloud.policysimulator.v1.IListReplayResultsResponse | null | undefined, protos.google.cloud.policysimulator.v1.IReplayResult>): void;

Parameters
Name	Description
request	IListReplayResultsRequest
callback	PaginationCallback<protos.google.cloud.policysimulator.v1.IListReplayResultsRequest, protos.google.cloud.policysimulator.v1.IListReplayResultsResponse | null | undefined, protos.google.cloud.policysimulator.v1.IReplayResult>

Returns
Type	Description
void

listReplayResultsAsync(request, options)

listReplayResultsAsync(request?: protos.google.cloud.policysimulator.v1.IListReplayResultsRequest, options?: CallOptions): AsyncIterable<protos.google.cloud.policysimulator.v1.IReplayResult>;

Equivalent to listReplayResults, but returns an iterable object.

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

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

Returns
Type	Description
AsyncIterable<protos.google.cloud.policysimulator.v1.IReplayResult>	{Object} An iterable Object that allows async iteration. When you iterate the returned iterable, each element will be an object representing ReplayResult. 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 Replay google.cloud.policysimulator.v1.Replay  whose
   *  results are listed, in the following format:
   *  `{projects|folders|organizations}/{resource-id}/locations/global/replays/{replay-id}`
   *  Example:
   *  `projects/my-project/locations/global/replays/506a5f7f-38ce-4d7d-8e03-479ce1833c36`
   */
  // const parent = 'abc123'
  /**
   *  The maximum number of
   *  ReplayResult google.cloud.policysimulator.v1.ReplayResult  objects to
   *  return. Defaults to 5000.
   *  The maximum value is 5000; values above 5000 are rounded down to 5000.
   */
  // const pageSize = 1234
  /**
   *  A page token, received from a previous
   *  Simulator.ListReplayResults google.cloud.policysimulator.v1.Simulator.ListReplayResults 
   *  call. Provide this token to retrieve the next page of results.
   *  When paginating, all other parameters provided to
   *  Simulator.ListReplayResults  must match the call that provided the page
   *  token.
   */
  // const pageToken = 'abc123'

  // Imports the Policysimulator library
  const {SimulatorClient} = require('@google-cloud/policysimulator').v1;

  // Instantiates a client
  const policysimulatorClient = new SimulatorClient();

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

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

  callListReplayResults();

listReplayResultsStream(request, options)

listReplayResultsStream(request?: protos.google.cloud.policysimulator.v1.IListReplayResultsRequest, options?: CallOptions): Transform;

Equivalent to listReplayResults, but returns a NodeJS Stream object.

Parameters
Name	Description
request	IListReplayResultsRequest 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 ReplayResult 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 listReplayResultsAsync() method described below for async iteration which you can stop as needed. Please see the documentation for more details and examples.

matchFolderFromFolderLocationReplayName(folderLocationReplayName)

matchFolderFromFolderLocationReplayName(folderLocationReplayName: string): string | number;

Parse the folder from FolderLocationReplay resource.

Parameter
Name	Description
folderLocationReplayName	string A fully-qualified path representing folder_location_replay resource.

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

matchFolderFromFolderLocationReplayReplayResultName(folderLocationReplayReplayResultName)

matchFolderFromFolderLocationReplayReplayResultName(folderLocationReplayReplayResultName: string): string | number;

Parse the folder from FolderLocationReplayReplayResult resource.

Parameter
Name	Description
folderLocationReplayReplayResultName	string A fully-qualified path representing folder_location_replay_replay_result resource.

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

matchLocationFromFolderLocationReplayName(folderLocationReplayName)

matchLocationFromFolderLocationReplayName(folderLocationReplayName: string): string | number;

Parse the location from FolderLocationReplay resource.

Parameter
Name	Description
folderLocationReplayName	string A fully-qualified path representing folder_location_replay resource.

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

matchLocationFromFolderLocationReplayReplayResultName(folderLocationReplayReplayResultName)

matchLocationFromFolderLocationReplayReplayResultName(folderLocationReplayReplayResultName: string): string | number;

Parse the location from FolderLocationReplayReplayResult resource.

Parameter
Name	Description
folderLocationReplayReplayResultName	string A fully-qualified path representing folder_location_replay_replay_result resource.

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

matchLocationFromOrganizationLocationReplayName(organizationLocationReplayName)

matchLocationFromOrganizationLocationReplayName(organizationLocationReplayName: string): string | number;

Parse the location from OrganizationLocationReplay resource.

Parameter
Name	Description
organizationLocationReplayName	string A fully-qualified path representing organization_location_replay resource.

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

matchLocationFromOrganizationLocationReplayReplayResultName(organizationLocationReplayReplayResultName)

matchLocationFromOrganizationLocationReplayReplayResultName(organizationLocationReplayReplayResultName: string): string | number;

Parse the location from OrganizationLocationReplayReplayResult resource.

Parameter
Name	Description
organizationLocationReplayReplayResultName	string A fully-qualified path representing organization_location_replay_replay_result resource.

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

matchLocationFromProjectLocationReplayName(projectLocationReplayName)

matchLocationFromProjectLocationReplayName(projectLocationReplayName: string): string | number;

Parse the location from ProjectLocationReplay resource.

Parameter
Name	Description
projectLocationReplayName	string A fully-qualified path representing project_location_replay resource.

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

matchLocationFromProjectLocationReplayReplayResultName(projectLocationReplayReplayResultName)

matchLocationFromProjectLocationReplayReplayResultName(projectLocationReplayReplayResultName: string): string | number;

Parse the location from ProjectLocationReplayReplayResult resource.

Parameter
Name	Description
projectLocationReplayReplayResultName	string A fully-qualified path representing project_location_replay_replay_result resource.

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

matchOrganizationFromOrganizationLocationReplayName(organizationLocationReplayName)

matchOrganizationFromOrganizationLocationReplayName(organizationLocationReplayName: string): string | number;

Parse the organization from OrganizationLocationReplay resource.

Parameter
Name	Description
organizationLocationReplayName	string A fully-qualified path representing organization_location_replay resource.

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

matchOrganizationFromOrganizationLocationReplayReplayResultName(organizationLocationReplayReplayResultName)

matchOrganizationFromOrganizationLocationReplayReplayResultName(organizationLocationReplayReplayResultName: string): string | number;

Parse the organization from OrganizationLocationReplayReplayResult resource.

Parameter
Name	Description
organizationLocationReplayReplayResultName	string A fully-qualified path representing organization_location_replay_replay_result resource.

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

matchProjectFromProjectLocationReplayName(projectLocationReplayName)

matchProjectFromProjectLocationReplayName(projectLocationReplayName: string): string | number;

Parse the project from ProjectLocationReplay resource.

Parameter
Name	Description
projectLocationReplayName	string A fully-qualified path representing project_location_replay resource.

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

matchProjectFromProjectLocationReplayReplayResultName(projectLocationReplayReplayResultName)

matchProjectFromProjectLocationReplayReplayResultName(projectLocationReplayReplayResultName: string): string | number;

Parse the project from ProjectLocationReplayReplayResult resource.

Parameter
Name	Description
projectLocationReplayReplayResultName	string A fully-qualified path representing project_location_replay_replay_result resource.

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

matchReplayFromFolderLocationReplayName(folderLocationReplayName)

matchReplayFromFolderLocationReplayName(folderLocationReplayName: string): string | number;

Parse the replay from FolderLocationReplay resource.

Parameter
Name	Description
folderLocationReplayName	string A fully-qualified path representing folder_location_replay resource.

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

matchReplayFromFolderLocationReplayReplayResultName(folderLocationReplayReplayResultName)

matchReplayFromFolderLocationReplayReplayResultName(folderLocationReplayReplayResultName: string): string | number;

Parse the replay from FolderLocationReplayReplayResult resource.

Parameter
Name	Description
folderLocationReplayReplayResultName	string A fully-qualified path representing folder_location_replay_replay_result resource.

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

matchReplayFromOrganizationLocationReplayName(organizationLocationReplayName)

matchReplayFromOrganizationLocationReplayName(organizationLocationReplayName: string): string | number;

Parse the replay from OrganizationLocationReplay resource.

Parameter
Name	Description
organizationLocationReplayName	string A fully-qualified path representing organization_location_replay resource.

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

matchReplayFromOrganizationLocationReplayReplayResultName(organizationLocationReplayReplayResultName)

matchReplayFromOrganizationLocationReplayReplayResultName(organizationLocationReplayReplayResultName: string): string | number;

Parse the replay from OrganizationLocationReplayReplayResult resource.

Parameter
Name	Description
organizationLocationReplayReplayResultName	string A fully-qualified path representing organization_location_replay_replay_result resource.

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

matchReplayFromProjectLocationReplayName(projectLocationReplayName)

matchReplayFromProjectLocationReplayName(projectLocationReplayName: string): string | number;

Parse the replay from ProjectLocationReplay resource.

Parameter
Name	Description
projectLocationReplayName	string A fully-qualified path representing project_location_replay resource.

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

matchReplayFromProjectLocationReplayReplayResultName(projectLocationReplayReplayResultName)

matchReplayFromProjectLocationReplayReplayResultName(projectLocationReplayReplayResultName: string): string | number;

Parse the replay from ProjectLocationReplayReplayResult resource.

Parameter
Name	Description
projectLocationReplayReplayResultName	string A fully-qualified path representing project_location_replay_replay_result resource.

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

matchReplayResultFromFolderLocationReplayReplayResultName(folderLocationReplayReplayResultName)

matchReplayResultFromFolderLocationReplayReplayResultName(folderLocationReplayReplayResultName: string): string | number;

Parse the replay_result from FolderLocationReplayReplayResult resource.

Parameter
Name	Description
folderLocationReplayReplayResultName	string A fully-qualified path representing folder_location_replay_replay_result resource.

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

matchReplayResultFromOrganizationLocationReplayReplayResultName(organizationLocationReplayReplayResultName)

matchReplayResultFromOrganizationLocationReplayReplayResultName(organizationLocationReplayReplayResultName: string): string | number;

Parse the replay_result from OrganizationLocationReplayReplayResult resource.

Parameter
Name	Description
organizationLocationReplayReplayResultName	string A fully-qualified path representing organization_location_replay_replay_result resource.

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

matchReplayResultFromProjectLocationReplayReplayResultName(projectLocationReplayReplayResultName)

matchReplayResultFromProjectLocationReplayReplayResultName(projectLocationReplayReplayResultName: string): string | number;

Parse the replay_result from ProjectLocationReplayReplayResult resource.

Parameter
Name	Description
projectLocationReplayReplayResultName	string A fully-qualified path representing project_location_replay_replay_result resource.

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

organizationLocationReplayPath(organization, location, replay)

organizationLocationReplayPath(organization: string, location: string, replay: string): string;

Return a fully-qualified organizationLocationReplay resource name string.

Parameters
Name	Description
organization	string
location	string
replay	string

Returns
Type	Description
string	{string} Resource name string.

organizationLocationReplayReplayResultPath(organization, location, replay, replayResult)

organizationLocationReplayReplayResultPath(organization: string, location: string, replay: string, replayResult: string): string;

Return a fully-qualified organizationLocationReplayReplayResult resource name string.

Parameters
Name	Description
organization	string
location	string
replay	string
replayResult	string

Returns
Type	Description
string	{string} Resource name string.

projectLocationReplayPath(project, location, replay)

projectLocationReplayPath(project: string, location: string, replay: string): string;

Return a fully-qualified projectLocationReplay resource name string.

Parameters
Name	Description
project	string
location	string
replay	string

Returns
Type	Description
string	{string} Resource name string.

projectLocationReplayReplayResultPath(project, location, replay, replayResult)

projectLocationReplayReplayResultPath(project: string, location: string, replay: string, replayResult: string): string;

Return a fully-qualified projectLocationReplayReplayResult resource name string.

Parameters
Name	Description
project	string
location	string
replay	string
replayResult	string

Returns
Type	Description
string	{string} Resource name string.