LivestreamServiceClient - Documentation

Constructor

new LivestreamServiceClient(optionsopt, gaxInstanceopt)

Construct an instance of LivestreamServiceClient.

Parameters:

Name Type Attributes Description

options

object

The configuration object. The options accepted by the constructor are described in detail in this document. The common options are:

Properties

Name Type Attributes Description

credentials

object

Credentials object.

Properties

Name	Type	Attributes	Description
`client_email`	string	<optional>
`private_key`	string	<optional>

email

string

Account email address. Required when using a .pem or .p12 keyFilename.

keyFilename

string

Full path to the a .json, .pem, or .p12 key downloaded from the Google Developers Console. If you provide a path to a JSON file, the projectId option below is not necessary. NOTE: .pem and .p12 require you to specify options.email as well.

port

number

The port on which to connect to the remote host.

projectId

string

The project ID from the Google Developer's Console, e.g. 'grape-spaceship-123'. We will also check the environment variable GCLOUD_PROJECT for your project ID. If your app is running in an environment which supports Application Default Credentials, your project ID will be detected automatically.

apiEndpoint

string

The domain name of the API remote host.

clientConfig

gax.ClientConfig

Client configuration override. Follows the structure of gapicConfig.

fallback

boolean

Use HTTP/1.1 REST mode. For more information, please check the documentation.

gaxInstance

gax

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 LivestreamServiceClient({fallback: true}, gax);

Members

apiEndpoint

The DNS address for this API service - same as servicePath(), exists for compatibility reasons.

port

The port for this API service.

scopes

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

servicePath

The DNS address for this API service.

Methods

assetPath(project, location, asset) → {string}

Return a fully-qualified asset resource name string.

Parameters:

Name	Type	Description
`project`	string
`location`	string
`asset`	string

Returns:

Type	Description
string	Resource name string.

cancelOperation(request, optionsopt, callbackopt) → {Promise}

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 Operations.GetOperation 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 Operation.error value with a google.rpc.Status.code of 1, corresponding to Code.CANCELLED.

Parameters:

Name Type Attributes Description

request

Object

The request object that will be sent.

Properties

Name	Type	Description
`name`	string	The name of the operation resource to be cancelled.

options

Object

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

callback

function

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

Returns:

Type	Description
Promise	The promise which resolves when API call finishes. The promise has a method named "cancel" which cancels the ongoing API call.

Example

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

channelPath(project, location, channel) → {string}

Return a fully-qualified channel resource name string.

Parameters:

Name	Type	Description
`project`	string
`location`	string
`channel`	string

Returns:

Type	Description
string	Resource name string.

(async) checkCreateAssetProgress(name) → {Promise}

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

Parameters:

Name	Type	Description
`name`	String	The operation name that will be passed.

Returns:

Type	Description
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 location for the resource, in the form of:
   *  `projects/{project}/locations/{location}`.
   */
  // const parent = 'abc123'
  /**
   *  Required. The asset resource to be created.
   */
  // const asset = {}
  /**
   *  Required. The ID of the asset resource to be created.
   *  This value must be 1-63 characters, begin and end with `[a-z0-9]`,
   *  could contain dashes (-) in between.
   */
  // const assetId = 'abc123'
  /**
   *  A request ID to identify requests. Specify a unique request ID
   *  so that if you must retry your request, the server will know to ignore
   *  the request if it has already been completed. The server will guarantee
   *  that for at least 60 minutes since the first request.
   *  For example, consider a situation where you make an initial request and the
   *  request times out. If you make the request again with the same request ID,
   *  the server can check if original operation with the same request ID was
   *  received, and if so, will ignore the second request. This prevents clients
   *  from accidentally creating duplicate commitments.
   *  The request ID must be a valid UUID with the exception that zero UUID is
   *  not supported `(00000000-0000-0000-0000-000000000000)`.
   */
  // const requestId = 'abc123'

  // Imports the Livestream library
  const {LivestreamServiceClient} = require('@google-cloud/livestream').v1;

  // Instantiates a client
  const livestreamClient = new LivestreamServiceClient();

  async function callCreateAsset() {
    // Construct request
    const request = {
      parent,
      asset,
      assetId,
    };

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

  callCreateAsset();

(async) checkCreateChannelProgress(name) → {Promise}

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

Parameters:

Name	Type	Description
`name`	String	The operation name that will be passed.

Returns:

Type	Description
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 location for the resource, in the form of:
   *  `projects/{project}/locations/{location}`.
   */
  // const parent = 'abc123'
  /**
   *  Required. The channel resource to be created.
   */
  // const channel = {}
  /**
   *  Required. The ID of the channel resource to be created.
   *  This value must be 1-63 characters, begin and end with `[a-z0-9]`,
   *  could contain dashes (-) in between.
   */
  // const channelId = 'abc123'
  /**
   *  A request ID to identify requests. Specify a unique request ID
   *  so that if you must retry your request, the server will know to ignore
   *  the request if it has already been completed. The server will guarantee
   *  that for at least 60 minutes since the first request.
   *  For example, consider a situation where you make an initial request and the
   *  request times out. If you make the request again with the same request ID,
   *  the server can check if original operation with the same request ID was
   *  received, and if so, will ignore the second request. This prevents clients
   *  from accidentally creating duplicate commitments.
   *  The request ID must be a valid UUID with the exception that zero UUID is
   *  not supported `(00000000-0000-0000-0000-000000000000)`.
   */
  // const requestId = 'abc123'

  // Imports the Livestream library
  const {LivestreamServiceClient} = require('@google-cloud/livestream').v1;

  // Instantiates a client
  const livestreamClient = new LivestreamServiceClient();

  async function callCreateChannel() {
    // Construct request
    const request = {
      parent,
      channel,
      channelId,
    };

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

  callCreateChannel();

(async) checkCreateInputProgress(name) → {Promise}

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

Parameters:

Name	Type	Description
`name`	String	The operation name that will be passed.

Returns:

Type	Description
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 location for the resource, in the form of:
   *  `projects/{project}/locations/{location}`.
   */
  // const parent = 'abc123'
  /**
   *  Required. The input resource to be created.
   */
  // const input = {}
  /**
   *  Required. The ID of the input resource to be created.
   *  This value must be 1-63 characters, begin and end with `[a-z0-9]`,
   *  could contain dashes (-) in between.
   */
  // const inputId = 'abc123'
  /**
   *  A request ID to identify requests. Specify a unique request ID
   *  so that if you must retry your request, the server will know to ignore
   *  the request if it has already been completed. The server will guarantee
   *  that for at least 60 minutes since the first request.
   *  For example, consider a situation where you make an initial request and the
   *  request times out. If you make the request again with the same request ID,
   *  the server can check if original operation with the same request ID was
   *  received, and if so, will ignore the second request. This prevents clients
   *  from accidentally creating duplicate commitments.
   *  The request ID must be a valid UUID with the exception that zero UUID is
   *  not supported `(00000000-0000-0000-0000-000000000000)`.
   */
  // const requestId = 'abc123'

  // Imports the Livestream library
  const {LivestreamServiceClient} = require('@google-cloud/livestream').v1;

  // Instantiates a client
  const livestreamClient = new LivestreamServiceClient();

  async function callCreateInput() {
    // Construct request
    const request = {
      parent,
      input,
      inputId,
    };

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

  callCreateInput();

(async) checkDeleteAssetProgress(name) → {Promise}

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

Parameters:

Name	Type	Description
`name`	String	The operation name that will be passed.

Returns:

Type	Description
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 asset resource, in the form of:
   *  `projects/{project}/locations/{location}/assets/{assetId}`.
   */
  // const name = 'abc123'
  /**
   *  A request ID to identify requests. Specify a unique request ID
   *  so that if you must retry your request, the server will know to ignore
   *  the request if it has already been completed. The server will guarantee
   *  that for at least 60 minutes after the first request.
   *  For example, consider a situation where you make an initial request and the
   *  request times out. If you make the request again with the same request ID,
   *  the server can check if original operation with the same request ID was
   *  received, and if so, will ignore the second request. This prevents clients
   *  from accidentally creating duplicate commitments.
   *  The request ID must be a valid UUID with the exception that zero UUID is
   *  not supported `(00000000-0000-0000-0000-000000000000)`.
   */
  // const requestId = 'abc123'

  // Imports the Livestream library
  const {LivestreamServiceClient} = require('@google-cloud/livestream').v1;

  // Instantiates a client
  const livestreamClient = new LivestreamServiceClient();

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

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

  callDeleteAsset();

(async) checkDeleteChannelProgress(name) → {Promise}

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

Parameters:

Name	Type	Description
`name`	String	The operation name that will be passed.

Returns:

Type	Description
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 channel resource, in the form of:
   *  `projects/{project}/locations/{location}/channels/{channelId}`.
   */
  // const name = 'abc123'
  /**
   *  A request ID to identify requests. Specify a unique request ID
   *  so that if you must retry your request, the server will know to ignore
   *  the request if it has already been completed. The server will guarantee
   *  that for at least 60 minutes after the first request.
   *  For example, consider a situation where you make an initial request and the
   *  request times out. If you make the request again with the same request ID,
   *  the server can check if original operation with the same request ID was
   *  received, and if so, will ignore the second request. This prevents clients
   *  from accidentally creating duplicate commitments.
   *  The request ID must be a valid UUID with the exception that zero UUID is
   *  not supported `(00000000-0000-0000-0000-000000000000)`.
   */
  // const requestId = 'abc123'
  /**
   *  If the `force` field is set to the default value of `false`, you must
   *  delete all of a channel's events before you can delete the channel itself.
   *  If the field is set to `true`, requests to delete a channel also delete
   *  associated channel events.
   */
  // const force = true

  // Imports the Livestream library
  const {LivestreamServiceClient} = require('@google-cloud/livestream').v1;

  // Instantiates a client
  const livestreamClient = new LivestreamServiceClient();

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

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

  callDeleteChannel();

(async) checkDeleteInputProgress(name) → {Promise}

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

Parameters:

Name	Type	Description
`name`	String	The operation name that will be passed.

Returns:

Type	Description
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 input resource, in the form of:
   *  `projects/{project}/locations/{location}/inputs/{inputId}`.
   */
  // const name = 'abc123'
  /**
   *  A request ID to identify requests. Specify a unique request ID
   *  so that if you must retry your request, the server will know to ignore
   *  the request if it has already been completed. The server will guarantee
   *  that for at least 60 minutes since the first request.
   *  For example, consider a situation where you make an initial request and the
   *  request times out. If you make the request again with the same request ID,
   *  the server can check if original operation with the same request ID was
   *  received, and if so, will ignore the second request. This prevents clients
   *  from accidentally creating duplicate commitments.
   *  The request ID must be a valid UUID with the exception that zero UUID is
   *  not supported `(00000000-0000-0000-0000-000000000000)`.
   */
  // const requestId = 'abc123'

  // Imports the Livestream library
  const {LivestreamServiceClient} = require('@google-cloud/livestream').v1;

  // Instantiates a client
  const livestreamClient = new LivestreamServiceClient();

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

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

  callDeleteInput();

(async) checkStartChannelProgress(name) → {Promise}

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

Parameters:

Name	Type	Description
`name`	String	The operation name that will be passed.

Returns:

Type	Description
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 channel resource, in the form of:
   *  `projects/{project}/locations/{location}/channels/{channelId}`.
   */
  // const name = 'abc123'
  /**
   *  A request ID to identify requests. Specify a unique request ID
   *  so that if you must retry your request, the server will know to ignore
   *  the request if it has already been completed. The server will guarantee
   *  that for at least 60 minutes since the first request.
   *  For example, consider a situation where you make an initial request and the
   *  request times out. If you make the request again with the same request ID,
   *  the server can check if original operation with the same request ID was
   *  received, and if so, will ignore the second request. This prevents clients
   *  from accidentally creating duplicate commitments.
   *  The request ID must be a valid UUID with the exception that zero UUID is
   *  not supported `(00000000-0000-0000-0000-000000000000)`.
   */
  // const requestId = 'abc123'

  // Imports the Livestream library
  const {LivestreamServiceClient} = require('@google-cloud/livestream').v1;

  // Instantiates a client
  const livestreamClient = new LivestreamServiceClient();

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

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

  callStartChannel();

(async) checkStopChannelProgress(name) → {Promise}

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

Parameters:

Name	Type	Description
`name`	String	The operation name that will be passed.

Returns:

Type	Description
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 channel resource, in the form of:
   *  `projects/{project}/locations/{location}/channels/{channelId}`.
   */
  // const name = 'abc123'
  /**
   *  A request ID to identify requests. Specify a unique request ID
   *  so that if you must retry your request, the server will know to ignore
   *  the request if it has already been completed. The server will guarantee
   *  that for at least 60 minutes since the first request.
   *  For example, consider a situation where you make an initial request and the
   *  request times out. If you make the request again with the same request ID,
   *  the server can check if original operation with the same request ID was
   *  received, and if so, will ignore the second request. This prevents clients
   *  from accidentally creating duplicate commitments.
   *  The request ID must be a valid UUID with the exception that zero UUID is
   *  not supported `(00000000-0000-0000-0000-000000000000)`.
   */
  // const requestId = 'abc123'

  // Imports the Livestream library
  const {LivestreamServiceClient} = require('@google-cloud/livestream').v1;

  // Instantiates a client
  const livestreamClient = new LivestreamServiceClient();

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

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

  callStopChannel();

(async) checkUpdateChannelProgress(name) → {Promise}

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

Parameters:

Name	Type	Description
`name`	String	The operation name that will be passed.

Returns:

Type	Description
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.
   */
  /**
   *  Field mask is used to specify the fields to be overwritten in the Channel
   *  resource by the update. You can only update the following fields:
   *  * `inputAttachments` (https://cloud.google.com/livestream/docs/reference/rest/v1/projects.locations.channels#inputattachment)
   *  * `inputConfig` (https://cloud.google.com/livestream/docs/reference/rest/v1/projects.locations.channels#inputconfig)
   *  * `output` (https://cloud.google.com/livestream/docs/reference/rest/v1/projects.locations.channels#output)
   *  * `elementaryStreams` (https://cloud.google.com/livestream/docs/reference/rest/v1/projects.locations.channels#elementarystream)
   *  * `muxStreams` (https://cloud.google.com/livestream/docs/reference/rest/v1/projects.locations.channels#muxstream)
   *  * `manifests` (https://cloud.google.com/livestream/docs/reference/rest/v1/projects.locations.channels#manifest)
   *  * `spriteSheets` (https://cloud.google.com/livestream/docs/reference/rest/v1/projects.locations.channels#spritesheet)
   *  * `logConfig` (https://cloud.google.com/livestream/docs/reference/rest/v1/projects.locations.channels#logconfig)
   *  * `timecodeConfig` (https://cloud.google.com/livestream/docs/reference/rest/v1/projects.locations.channels#timecodeconfig)
   *  * `encryptions` (https://cloud.google.com/livestream/docs/reference/rest/v1/projects.locations.channels#encryption)
   *  The fields specified in the update_mask are relative to the resource, not
   *  the full request. A field will be overwritten if it is in the mask.
   *  If the mask is not present, then each field from the list above is updated
   *  if the field appears in the request payload. To unset a field, add the
   *  field to the update mask and remove it from the request payload.
   */
  // const updateMask = {}
  /**
   *  Required. The channel resource to be updated.
   */
  // const channel = {}
  /**
   *  A request ID to identify requests. Specify a unique request ID
   *  so that if you must retry your request, the server will know to ignore
   *  the request if it has already been completed. The server will guarantee
   *  that for at least 60 minutes since the first request.
   *  For example, consider a situation where you make an initial request and the
   *  request times out. If you make the request again with the same request ID,
   *  the server can check if original operation with the same request ID was
   *  received, and if so, will ignore the second request. This prevents clients
   *  from accidentally creating duplicate commitments.
   *  The request ID must be a valid UUID with the exception that zero UUID is
   *  not supported `(00000000-0000-0000-0000-000000000000)`.
   */
  // const requestId = 'abc123'

  // Imports the Livestream library
  const {LivestreamServiceClient} = require('@google-cloud/livestream').v1;

  // Instantiates a client
  const livestreamClient = new LivestreamServiceClient();

  async function callUpdateChannel() {
    // Construct request
    const request = {
      channel,
    };

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

  callUpdateChannel();

(async) checkUpdateInputProgress(name) → {Promise}

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

Parameters:

Name	Type	Description
`name`	String	The operation name that will be passed.

Returns:

Type	Description
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.
   */
  /**
   *  Field mask is used to specify the fields to be overwritten in the Input
   *  resource by the update. You can only update the following fields:
   *  * `preprocessingConfig` (https://cloud.google.com/livestream/docs/reference/rest/v1/projects.locations.inputs#PreprocessingConfig)
   *  * `securityRules` (https://cloud.google.com/livestream/docs/reference/rest/v1/projects.locations.inputs#SecurityRule)
   *  The fields specified in the update_mask are relative to the resource, not
   *  the full request. A field will be overwritten if it is in the mask.
   *  If the mask is not present, then each field from the list above is updated
   *  if the field appears in the request payload. To unset a field, add the
   *  field to the update mask and remove it from the request payload.
   */
  // const updateMask = {}
  /**
   *  Required. The input resource to be updated.
   */
  // const input = {}
  /**
   *  A request ID to identify requests. Specify a unique request ID
   *  so that if you must retry your request, the server will know to ignore
   *  the request if it has already been completed. The server will guarantee
   *  that for at least 60 minutes since the first request.
   *  For example, consider a situation where you make an initial request and the
   *  request times out. If you make the request again with the same request ID,
   *  the server can check if original operation with the same request ID was
   *  received, and if so, will ignore the second request. This prevents clients
   *  from accidentally creating duplicate commitments.
   *  The request ID must be a valid UUID with the exception that zero UUID is
   *  not supported `(00000000-0000-0000-0000-000000000000)`.
   */
  // const requestId = 'abc123'

  // Imports the Livestream library
  const {LivestreamServiceClient} = require('@google-cloud/livestream').v1;

  // Instantiates a client
  const livestreamClient = new LivestreamServiceClient();

  async function callUpdateInput() {
    // Construct request
    const request = {
      input,
    };

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

  callUpdateInput();

(async) checkUpdatePoolProgress(name) → {Promise}

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

Parameters:

Name	Type	Description
`name`	String	The operation name that will be passed.

Returns:

Type	Description
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.
   */
  /**
   *  Field mask is used to specify the fields to be overwritten in the Pool
   *  resource by the update. You can only update the following fields:
   *  * `networkConfig`
   *  The fields specified in the update_mask are relative to the resource, not
   *  the full request. A field will be overwritten if it is in the mask.
   */
  // const updateMask = {}
  /**
   *  Required. The pool resource to be updated.
   */
  // const pool = {}
  /**
   *  A request ID to identify requests. Specify a unique request ID
   *  so that if you must retry your request, the server will know to ignore
   *  the request if it has already been completed. The server will guarantee
   *  that for at least 60 minutes since the first request.
   *  For example, consider a situation where you make an initial request and the
   *  request times out. If you make the request again with the same request ID,
   *  the server can check if original operation with the same request ID was
   *  received, and if so, will ignore the second request. This prevents clients
   *  from accidentally creating duplicate commitments.
   *  The request ID must be a valid UUID with the exception that zero UUID is
   *  not supported `(00000000-0000-0000-0000-000000000000)`.
   */
  // const requestId = 'abc123'

  // Imports the Livestream library
  const {LivestreamServiceClient} = require('@google-cloud/livestream').v1;

  // Instantiates a client
  const livestreamClient = new LivestreamServiceClient();

  async function callUpdatePool() {
    // Construct request
    const request = {
      pool,
    };

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

  callUpdatePool();

close() → {Promise}

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	A promise that resolves when the client is closed.

deleteOperation(request, optionsopt, callbackopt) → {Promise}

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 Type Attributes Description

request

Object

The request object that will be sent.

Properties

Name	Type	Description
`name`	string	The name of the operation resource to be deleted.

options

Object

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

callback

function

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

Returns:

Type	Description
Promise	The promise which resolves when API call finishes. The promise has a method named "cancel" which cancels the ongoing API call.

Example

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

eventPath(project, location, channel, event) → {string}

Return a fully-qualified event resource name string.

Parameters:

Name	Type	Description
`project`	string
`location`	string
`channel`	string
`event`	string

Returns:

Type	Description
string	Resource name string.

getLocation(request, optionsopt) → {Promise}

Gets information about a location.

Parameters:

Name Type Attributes Description

request

Object

The request object that will be sent.

Properties

Name	Type	Description
`name`	string	Resource name for the location.

options

object

Call options. See CallOptions for more details.

Returns:

Type	Description
Promise	The promise which resolves to an array. The first element of the array is an object representing Location. Please see the documentation for more details and examples.

Example

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

getOperation(request, optionsopt, callbackopt) → {Promise}

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 Type Attributes Description

request

Object

The request object that will be sent.

Properties

Name	Type	Description
`name`	string	The name of the operation resource.

options

Object

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

callback

function

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

The second parameter to the callback is an object representing google.longrunning.Operation.

Returns:

Type	Description
Promise	The promise which resolves to an array. The first element of the array is an object representing google.longrunning.Operation. The promise has a method named "cancel" which cancels the ongoing API call.

Example

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

getProjectId() → {Promise}

Return the project ID used by this class.

Returns:

Type	Description
Promise	A promise that resolves to string containing the project ID.

initialize() → {Promise}

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	A promise that resolves to an authenticated service stub.

inputPath(project, location, input) → {string}

Return a fully-qualified input resource name string.

Parameters:

Name	Type	Description
`project`	string
`location`	string
`input`	string

Returns:

Type	Description
string	Resource name string.

listAssetsAsync(request, optionsopt) → {Object}

Equivalent to listAssets, but returns an iterable object.

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

Parameters:

Name Type Attributes Description

request

Object

The request object that will be sent.

Properties

Name	Type	Description
`parent`	string	Required. The parent location for the resource, in the form of: `projects/{project}/locations/{location}`.
`pageSize`	number	Requested page size. Server may return fewer items than requested. If unspecified, server will pick an appropriate default.
`pageToken`	string	A token identifying a page of results the server should return.
`filter`	string	Filtering results
`orderBy`	string	Hint for how to order the results

options

object

Call options. See CallOptions for more details.

Returns:

Type	Description
Object	An iterable Object that allows async iteration. When you iterate the returned iterable, each element will be an object representing Asset. 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 location for the resource, in the form of:
   *  `projects/{project}/locations/{location}`.
   */
  // const parent = 'abc123'
  /**
   *  Requested page size. Server may return fewer items than requested.
   *  If unspecified, server will pick an appropriate default.
   */
  // const pageSize = 1234
  /**
   *  A token identifying a page of results the server should return.
   */
  // const pageToken = 'abc123'
  /**
   *  Filtering results
   */
  // const filter = 'abc123'
  /**
   *  Hint for how to order the results
   */
  // const orderBy = 'abc123'

  // Imports the Livestream library
  const {LivestreamServiceClient} = require('@google-cloud/livestream').v1;

  // Instantiates a client
  const livestreamClient = new LivestreamServiceClient();

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

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

  callListAssets();

listAssetsStream(request, optionsopt) → {Stream}

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

Parameters:

Name Type Attributes Description

request

Object

The request object that will be sent.

Properties

Name	Type	Description
`parent`	string	Required. The parent location for the resource, in the form of: `projects/{project}/locations/{location}`.
`pageSize`	number	Requested page size. Server may return fewer items than requested. If unspecified, server will pick an appropriate default.
`pageToken`	string	A token identifying a page of results the server should return.
`filter`	string	Filtering results
`orderBy`	string	Hint for how to order the results

options

object

Call options. See CallOptions for more details.

Returns:

Type	Description
Stream	An object stream which emits an object representing Asset 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 `listAssetsAsync()` method described below for async iteration which you can stop as needed. Please see the documentation for more details and examples.

listChannelsAsync(request, optionsopt) → {Object}

Equivalent to listChannels, but returns an iterable object.

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

Parameters:

Name Type Attributes Description

request

Object

The request object that will be sent.

Properties

Name	Type	Description
`parent`	string	Required. The parent location for the resource, in the form of: `projects/{project}/locations/{location}`.
`pageSize`	number	The maximum number of items to return. If unspecified, server will pick an appropriate default. Server may return fewer items than requested. A caller should only rely on response's next_page_token to determine if there are more items left to be queried.
`pageToken`	string	The next_page_token value returned from a previous List request, if any.
`filter`	string	The filter to apply to list results.
`orderBy`	string	Specifies the ordering of results following syntax at https://cloud.google.com/apis/design/design_patterns#sorting_order.

options

object

Call options. See CallOptions for more details.

Returns:

Type	Description
Object	An iterable Object that allows async iteration. When you iterate the returned iterable, each element will be an object representing Channel. 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 location for the resource, in the form of:
   *  `projects/{project}/locations/{location}`.
   */
  // const parent = 'abc123'
  /**
   *  The maximum number of items to return. If unspecified, server
   *  will pick an appropriate default. Server may return fewer items than
   *  requested. A caller should only rely on response's
   *  next_page_token google.cloud.video.livestream.v1.ListChannelsResponse.next_page_token 
   *  to determine if there are more items left to be queried.
   */
  // const pageSize = 1234
  /**
   *  The next_page_token value returned from a previous List request, if any.
   */
  // const pageToken = 'abc123'
  /**
   *  The filter to apply to list results.
   */
  // const filter = 'abc123'
  /**
   *  Specifies the ordering of results following syntax at
   *  https://cloud.google.com/apis/design/design_patterns#sorting_order.
   */
  // const orderBy = 'abc123'

  // Imports the Livestream library
  const {LivestreamServiceClient} = require('@google-cloud/livestream').v1;

  // Instantiates a client
  const livestreamClient = new LivestreamServiceClient();

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

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

  callListChannels();

listChannelsStream(request, optionsopt) → {Stream}

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

Parameters:

Name Type Attributes Description

request

Object

The request object that will be sent.

Properties

Name	Type	Description
`parent`	string	Required. The parent location for the resource, in the form of: `projects/{project}/locations/{location}`.
`pageSize`	number	The maximum number of items to return. If unspecified, server will pick an appropriate default. Server may return fewer items than requested. A caller should only rely on response's next_page_token to determine if there are more items left to be queried.
`pageToken`	string	The next_page_token value returned from a previous List request, if any.
`filter`	string	The filter to apply to list results.
`orderBy`	string	Specifies the ordering of results following syntax at https://cloud.google.com/apis/design/design_patterns#sorting_order.

options

object

Call options. See CallOptions for more details.

Returns:

Type	Description
Stream	An object stream which emits an object representing Channel 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 `listChannelsAsync()` method described below for async iteration which you can stop as needed. Please see the documentation for more details and examples.

listEventsAsync(request, optionsopt) → {Object}

Equivalent to listEvents, but returns an iterable object.

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

Parameters:

Name Type Attributes Description

request

Object

The request object that will be sent.

Properties

Name	Type	Description
`parent`	string	Required. The parent channel for the resource, in the form of: `projects/{project}/locations/{location}/channels/{channelId}`.
`pageSize`	number	The maximum number of items to return. If unspecified, server will pick an appropriate default. Server may return fewer items than requested. A caller should only rely on response's next_page_token to determine if there are more items left to be queried.
`pageToken`	string	The next_page_token value returned from a previous List request, if any.
`filter`	string	The filter to apply to list results.
`orderBy`	string	Specifies the ordering of results following syntax at https://cloud.google.com/apis/design/design_patterns#sorting_order.

options

object

Call options. See CallOptions for more details.

Returns:

Type	Description
Object	An iterable Object that allows async iteration. When you iterate the returned iterable, each element will be an object representing Event. 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 channel for the resource, in the form of:
   *  `projects/{project}/locations/{location}/channels/{channelId}`.
   */
  // const parent = 'abc123'
  /**
   *  The maximum number of items to return. If unspecified, server
   *  will pick an appropriate default. Server may return fewer items than
   *  requested. A caller should only rely on response's
   *  next_page_token google.cloud.video.livestream.v1.ListEventsResponse.next_page_token 
   *  to determine if there are more items left to be queried.
   */
  // const pageSize = 1234
  /**
   *  The next_page_token value returned from a previous List request, if any.
   */
  // const pageToken = 'abc123'
  /**
   *  The filter to apply to list results.
   */
  // const filter = 'abc123'
  /**
   *  Specifies the ordering of results following syntax at
   *  https://cloud.google.com/apis/design/design_patterns#sorting_order.
   */
  // const orderBy = 'abc123'

  // Imports the Livestream library
  const {LivestreamServiceClient} = require('@google-cloud/livestream').v1;

  // Instantiates a client
  const livestreamClient = new LivestreamServiceClient();

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

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

  callListEvents();

listEventsStream(request, optionsopt) → {Stream}

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

Parameters:

Name Type Attributes Description

request

Object

The request object that will be sent.

Properties

Name	Type	Description
`parent`	string	Required. The parent channel for the resource, in the form of: `projects/{project}/locations/{location}/channels/{channelId}`.
`pageSize`	number	The maximum number of items to return. If unspecified, server will pick an appropriate default. Server may return fewer items than requested. A caller should only rely on response's next_page_token to determine if there are more items left to be queried.
`pageToken`	string	The next_page_token value returned from a previous List request, if any.
`filter`	string	The filter to apply to list results.
`orderBy`	string	Specifies the ordering of results following syntax at https://cloud.google.com/apis/design/design_patterns#sorting_order.

options

object

Call options. See CallOptions for more details.

Returns:

Type	Description
Stream	An object stream which emits an object representing Event 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 `listEventsAsync()` method described below for async iteration which you can stop as needed. Please see the documentation for more details and examples.

listInputsAsync(request, optionsopt) → {Object}

Equivalent to listInputs, but returns an iterable object.

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

Parameters:

Name Type Attributes Description

request

Object

The request object that will be sent.

Properties

Name	Type	Description
`parent`	string	Required. The parent location for the resource, in the form of: `projects/{project}/locations/{location}`.
`pageSize`	number	The maximum number of items to return. If unspecified, server will pick an appropriate default. Server may return fewer items than requested. A caller should only rely on response's next_page_token to determine if there are more items left to be queried.
`pageToken`	string	The next_page_token value returned from a previous List request, if any.
`filter`	string	The filter to apply to list results.
`orderBy`	string	Specifies the ordering of results following syntax at Sorting Order.

options

object

Call options. See CallOptions for more details.

Returns:

Type	Description
Object	An iterable Object that allows async iteration. When you iterate the returned iterable, each element will be an object representing Input. 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 location for the resource, in the form of:
   *  `projects/{project}/locations/{location}`.
   */
  // const parent = 'abc123'
  /**
   *  The maximum number of items to return. If unspecified, server
   *  will pick an appropriate default. Server may return fewer items than
   *  requested. A caller should only rely on response's
   *  next_page_token google.cloud.video.livestream.v1.ListInputsResponse.next_page_token 
   *  to determine if there are more items left to be queried.
   */
  // const pageSize = 1234
  /**
   *  The next_page_token value returned from a previous List request, if any.
   */
  // const pageToken = 'abc123'
  /**
   *  The filter to apply to list results.
   */
  // const filter = 'abc123'
  /**
   *  Specifies the ordering of results following syntax at Sorting
   *  Order (https://cloud.google.com/apis/design/design_patterns#sorting_order).
   */
  // const orderBy = 'abc123'

  // Imports the Livestream library
  const {LivestreamServiceClient} = require('@google-cloud/livestream').v1;

  // Instantiates a client
  const livestreamClient = new LivestreamServiceClient();

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

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

  callListInputs();

listInputsStream(request, optionsopt) → {Stream}

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

Parameters:

Name Type Attributes Description

request

Object

The request object that will be sent.

Properties

Name	Type	Description
`parent`	string	Required. The parent location for the resource, in the form of: `projects/{project}/locations/{location}`.
`pageSize`	number	The maximum number of items to return. If unspecified, server will pick an appropriate default. Server may return fewer items than requested. A caller should only rely on response's next_page_token to determine if there are more items left to be queried.
`pageToken`	string	The next_page_token value returned from a previous List request, if any.
`filter`	string	The filter to apply to list results.
`orderBy`	string	Specifies the ordering of results following syntax at Sorting Order.

options

object

Call options. See CallOptions for more details.

Returns:

Type	Description
Stream	An object stream which emits an object representing Input 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 `listInputsAsync()` method described below for async iteration which you can stop as needed. Please see the documentation for more details and examples.

listLocationsAsync(request, optionsopt) → {Object}

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 Type Attributes Description

request

Object

The request object that will be sent.

Properties

Name	Type	Description
`name`	string	The resource that owns the locations collection, if applicable.
`filter`	string	The standard list filter.
`pageSize`	number	The standard list page size.
`pageToken`	string	The standard list page token.

options

object

Call options. See CallOptions for more details.

Returns:

Type	Description
Object	An iterable Object that allows async iteration. When you iterate the returned iterable, each element will be an object representing Location. 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, optionsopt) → {Object}

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 Type Attributes Description

request

Object

The request object that will be sent.

Properties

Name	Type	Attributes	Description
`name`	string		The name of the operation collection.
`filter`	string		The standard list filter.
`pageSize`	number	<optional>	The maximum number of resources contained in the underlying API response. If page streaming is performed per-resource, this parameter does not affect the return value. If page streaming is performed per-page, this determines the maximum number of resources in a page.

options

Object

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
Object	An iterable Object that conforms to iteration protocols.

Example

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

locationPath(project, location) → {string}

Return a fully-qualified location resource name string.

Parameters:

Name	Type	Description
`project`	string
`location`	string

Returns:

Type	Description
string	Resource name string.

matchAssetFromAssetName(assetName) → {string}

Parse the asset from Asset resource.

Parameters:

Name	Type	Description
`assetName`	string	A fully-qualified path representing Asset resource.

Returns:

Type	Description
string	A string representing the asset.

matchChannelFromChannelName(channelName) → {string}

Parse the channel from Channel resource.

Parameters:

Name	Type	Description
`channelName`	string	A fully-qualified path representing Channel resource.

Returns:

Type	Description
string	A string representing the channel.

matchChannelFromEventName(eventName) → {string}

Parse the channel from Event resource.

Parameters:

Name	Type	Description
`eventName`	string	A fully-qualified path representing Event resource.

Returns:

Type	Description
string	A string representing the channel.

matchEventFromEventName(eventName) → {string}

Parse the event from Event resource.

Parameters:

Name	Type	Description
`eventName`	string	A fully-qualified path representing Event resource.

Returns:

Type	Description
string	A string representing the event.

matchInputFromInputName(inputName) → {string}

Parse the input from Input resource.

Parameters:

Name	Type	Description
`inputName`	string	A fully-qualified path representing Input resource.

Returns:

Type	Description
string	A string representing the input.

matchLocationFromAssetName(assetName) → {string}

Parse the location from Asset resource.

Parameters:

Name	Type	Description
`assetName`	string	A fully-qualified path representing Asset resource.

Returns:

Type	Description
string	A string representing the location.

matchLocationFromChannelName(channelName) → {string}

Parse the location from Channel resource.

Parameters:

Name	Type	Description
`channelName`	string	A fully-qualified path representing Channel resource.

Returns:

Type	Description
string	A string representing the location.

matchLocationFromEventName(eventName) → {string}

Parse the location from Event resource.

Parameters:

Name	Type	Description
`eventName`	string	A fully-qualified path representing Event resource.

Returns:

Type	Description
string	A string representing the location.

matchLocationFromInputName(inputName) → {string}

Parse the location from Input resource.

Parameters:

Name	Type	Description
`inputName`	string	A fully-qualified path representing Input resource.

Returns:

Type	Description
string	A string representing the location.

matchLocationFromLocationName(locationName) → {string}

Parse the location from Location resource.

Parameters:

Name	Type	Description
`locationName`	string	A fully-qualified path representing Location resource.

Returns:

Type	Description
string	A string representing the location.

matchLocationFromPoolName(poolName) → {string}

Parse the location from Pool resource.

Parameters:

Name	Type	Description
`poolName`	string	A fully-qualified path representing Pool resource.

Returns:

Type	Description
string	A string representing the location.

matchPoolFromPoolName(poolName) → {string}

Parse the pool from Pool resource.

Parameters:

Name	Type	Description
`poolName`	string	A fully-qualified path representing Pool resource.

Returns:

Type	Description
string	A string representing the pool.

matchProjectFromAssetName(assetName) → {string}

Parse the project from Asset resource.

Parameters:

Name	Type	Description
`assetName`	string	A fully-qualified path representing Asset resource.

Returns:

Type	Description
string	A string representing the project.

matchProjectFromChannelName(channelName) → {string}

Parse the project from Channel resource.

Parameters:

Name	Type	Description
`channelName`	string	A fully-qualified path representing Channel resource.

Returns:

Type	Description
string	A string representing the project.

matchProjectFromEventName(eventName) → {string}

Parse the project from Event resource.

Parameters:

Name	Type	Description
`eventName`	string	A fully-qualified path representing Event resource.

Returns:

Type	Description
string	A string representing the project.

matchProjectFromInputName(inputName) → {string}

Parse the project from Input resource.

Parameters:

Name	Type	Description
`inputName`	string	A fully-qualified path representing Input resource.

Returns:

Type	Description
string	A string representing the project.

matchProjectFromLocationName(locationName) → {string}

Parse the project from Location resource.

Parameters:

Name	Type	Description
`locationName`	string	A fully-qualified path representing Location resource.

Returns:

Type	Description
string	A string representing the project.

matchProjectFromPoolName(poolName) → {string}

Parse the project from Pool resource.

Parameters:

Name	Type	Description
`poolName`	string	A fully-qualified path representing Pool resource.

Returns:

Type	Description
string	A string representing the project.

matchProjectFromProjectName(projectName) → {string}

Parse the project from Project resource.

Parameters:

Name	Type	Description
`projectName`	string	A fully-qualified path representing Project resource.

Returns:

Type	Description
string	A string representing the project.

poolPath(project, location, pool) → {string}

Return a fully-qualified pool resource name string.

Parameters:

Name	Type	Description
`project`	string
`location`	string
`pool`	string

Returns:

Type	Description
string	Resource name string.

projectPath(project) → {string}

Return a fully-qualified project resource name string.

Parameters:

Name	Type	Description
`project`	string

Returns:

Type	Description
string	Resource name string.