Class v1alpha1.TelcoAutomationClient (0.1.0)

TelcoAutomation Service manages the control plane cluster a.k.a. Orchestration Cluster (GKE cluster with config controller) of TNA. It also exposes blueprint APIs which manages the lifecycle of blueprints that control the infrastructure setup (e.g GDCE clusters) and deployment of network functions. v1alpha1

Package

@google-cloud/telcoautomation

Constructors

(constructor)(opts, gaxInstance)

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

Construct an instance of TelcoAutomationClient.

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

Properties

apiEndpoint

get apiEndpoint(): string;

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

apiEndpoint

static get apiEndpoint(): string;

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

auth

auth: gax.GoogleAuth;

descriptors

descriptors: Descriptors;

innerApiCalls

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

locationsClient

locationsClient: LocationsClient;

operationsClient

operationsClient: gax.OperationsClient;

pathTemplates

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

port

static get port(): number;

The port for this API service.

scopes

static get scopes(): string[];

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

servicePath

get servicePath(): string;

The DNS address for this API service.

servicePath

static get servicePath(): string;

The DNS address for this API service.

telcoAutomationStub

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

universeDomain

get universeDomain(): string;

warn

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

Methods

applyDeployment(request, options)

applyDeployment(request?: protos.google.cloud.telcoautomation.v1alpha1.IApplyDeploymentRequest, options?: CallOptions): Promise<[
        protos.google.cloud.telcoautomation.v1alpha1.IDeployment,
        (protos.google.cloud.telcoautomation.v1alpha1.IApplyDeploymentRequest | undefined),
        {} | undefined
    ]>;

Applies the deployment's YAML files to the parent orchestration cluster.

Parameters
Name Description
request IApplyDeploymentRequest

The request object that will be sent.

options CallOptions

Call options. See CallOptions for more details.

Returns
Type Description
Promise<[ protos.google.cloud.telcoautomation.v1alpha1.IDeployment, (protos.google.cloud.telcoautomation.v1alpha1.IApplyDeploymentRequest | 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 deployment to apply to orchestration cluster.
   */
  // const name = 'abc123'

  // Imports the Telcoautomation library
  const {TelcoAutomationClient} = require('@google-cloud/telcoautomation').v1alpha1;

  // Instantiates a client
  const telcoautomationClient = new TelcoAutomationClient();

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

    // Run request
    const response = await telcoautomationClient.applyDeployment(request);
    console.log(response);
  }

  callApplyDeployment();

applyDeployment(request, options, callback)

applyDeployment(request: protos.google.cloud.telcoautomation.v1alpha1.IApplyDeploymentRequest, options: CallOptions, callback: Callback<protos.google.cloud.telcoautomation.v1alpha1.IDeployment, protos.google.cloud.telcoautomation.v1alpha1.IApplyDeploymentRequest | null | undefined, {} | null | undefined>): void;
Parameters
Name Description
request IApplyDeploymentRequest
options CallOptions
callback Callback<protos.google.cloud.telcoautomation.v1alpha1.IDeployment, protos.google.cloud.telcoautomation.v1alpha1.IApplyDeploymentRequest | null | undefined, {} | null | undefined>
Returns
Type Description
void

applyDeployment(request, callback)

applyDeployment(request: protos.google.cloud.telcoautomation.v1alpha1.IApplyDeploymentRequest, callback: Callback<protos.google.cloud.telcoautomation.v1alpha1.IDeployment, protos.google.cloud.telcoautomation.v1alpha1.IApplyDeploymentRequest | null | undefined, {} | null | undefined>): void;
Parameters
Name Description
request IApplyDeploymentRequest
callback Callback<protos.google.cloud.telcoautomation.v1alpha1.IDeployment, protos.google.cloud.telcoautomation.v1alpha1.IApplyDeploymentRequest | null | undefined, {} | null | undefined>
Returns
Type Description
void

applyHydratedDeployment(request, options)

applyHydratedDeployment(request?: protos.google.cloud.telcoautomation.v1alpha1.IApplyHydratedDeploymentRequest, options?: CallOptions): Promise<[
        protos.google.cloud.telcoautomation.v1alpha1.IHydratedDeployment,
        (protos.google.cloud.telcoautomation.v1alpha1.IApplyHydratedDeploymentRequest | undefined),
        {} | undefined
    ]>;

Applies a hydrated deployment to a workload cluster.

Parameters
Name Description
request IApplyHydratedDeploymentRequest

The request object that will be sent.

options CallOptions

Call options. See CallOptions for more details.

Returns
Type Description
Promise<[ protos.google.cloud.telcoautomation.v1alpha1.IHydratedDeployment, (protos.google.cloud.telcoautomation.v1alpha1.IApplyHydratedDeploymentRequest | 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 hydrated deployment to apply.
   */
  // const name = 'abc123'

  // Imports the Telcoautomation library
  const {TelcoAutomationClient} = require('@google-cloud/telcoautomation').v1alpha1;

  // Instantiates a client
  const telcoautomationClient = new TelcoAutomationClient();

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

    // Run request
    const response = await telcoautomationClient.applyHydratedDeployment(request);
    console.log(response);
  }

  callApplyHydratedDeployment();

applyHydratedDeployment(request, options, callback)

applyHydratedDeployment(request: protos.google.cloud.telcoautomation.v1alpha1.IApplyHydratedDeploymentRequest, options: CallOptions, callback: Callback<protos.google.cloud.telcoautomation.v1alpha1.IHydratedDeployment, protos.google.cloud.telcoautomation.v1alpha1.IApplyHydratedDeploymentRequest | null | undefined, {} | null | undefined>): void;
Parameters
Name Description
request IApplyHydratedDeploymentRequest
options CallOptions
callback Callback<protos.google.cloud.telcoautomation.v1alpha1.IHydratedDeployment, protos.google.cloud.telcoautomation.v1alpha1.IApplyHydratedDeploymentRequest | null | undefined, {} | null | undefined>
Returns
Type Description
void

applyHydratedDeployment(request, callback)

applyHydratedDeployment(request: protos.google.cloud.telcoautomation.v1alpha1.IApplyHydratedDeploymentRequest, callback: Callback<protos.google.cloud.telcoautomation.v1alpha1.IHydratedDeployment, protos.google.cloud.telcoautomation.v1alpha1.IApplyHydratedDeploymentRequest | null | undefined, {} | null | undefined>): void;
Parameters
Name Description
request IApplyHydratedDeploymentRequest
callback Callback<protos.google.cloud.telcoautomation.v1alpha1.IHydratedDeployment, protos.google.cloud.telcoautomation.v1alpha1.IApplyHydratedDeploymentRequest | null | undefined, {} | null | undefined>
Returns
Type Description
void

approveBlueprint(request, options)

approveBlueprint(request?: protos.google.cloud.telcoautomation.v1alpha1.IApproveBlueprintRequest, options?: CallOptions): Promise<[
        protos.google.cloud.telcoautomation.v1alpha1.IBlueprint,
        (protos.google.cloud.telcoautomation.v1alpha1.IApproveBlueprintRequest | undefined),
        {} | undefined
    ]>;

Approves a blueprint and commits a new revision.

Parameters
Name Description
request IApproveBlueprintRequest

The request object that will be sent.

options CallOptions

Call options. See CallOptions for more details.

Returns
Type Description
Promise<[ protos.google.cloud.telcoautomation.v1alpha1.IBlueprint, (protos.google.cloud.telcoautomation.v1alpha1.IApproveBlueprintRequest | 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 blueprint to approve. The blueprint must be in
   *  Proposed state. A new revision is committed on approval.
   */
  // const name = 'abc123'

  // Imports the Telcoautomation library
  const {TelcoAutomationClient} = require('@google-cloud/telcoautomation').v1alpha1;

  // Instantiates a client
  const telcoautomationClient = new TelcoAutomationClient();

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

    // Run request
    const response = await telcoautomationClient.approveBlueprint(request);
    console.log(response);
  }

  callApproveBlueprint();

approveBlueprint(request, options, callback)

approveBlueprint(request: protos.google.cloud.telcoautomation.v1alpha1.IApproveBlueprintRequest, options: CallOptions, callback: Callback<protos.google.cloud.telcoautomation.v1alpha1.IBlueprint, protos.google.cloud.telcoautomation.v1alpha1.IApproveBlueprintRequest | null | undefined, {} | null | undefined>): void;
Parameters
Name Description
request IApproveBlueprintRequest
options CallOptions
callback Callback<protos.google.cloud.telcoautomation.v1alpha1.IBlueprint, protos.google.cloud.telcoautomation.v1alpha1.IApproveBlueprintRequest | null | undefined, {} | null | undefined>
Returns
Type Description
void

approveBlueprint(request, callback)

approveBlueprint(request: protos.google.cloud.telcoautomation.v1alpha1.IApproveBlueprintRequest, callback: Callback<protos.google.cloud.telcoautomation.v1alpha1.IBlueprint, protos.google.cloud.telcoautomation.v1alpha1.IApproveBlueprintRequest | null | undefined, {} | null | undefined>): void;
Parameters
Name Description
request IApproveBlueprintRequest
callback Callback<protos.google.cloud.telcoautomation.v1alpha1.IBlueprint, protos.google.cloud.telcoautomation.v1alpha1.IApproveBlueprintRequest | null | undefined, {} | null | undefined>
Returns
Type Description
void

blueprintPath(project, location, orchestrationCluster, blueprint)

blueprintPath(project: string, location: string, orchestrationCluster: string, blueprint: string): string;

Return a fully-qualified blueprint resource name string.

Parameters
Name Description
project string
location string
orchestrationCluster string
blueprint string
Returns
Type Description
string

{string} Resource name string.

cancelOperation(request, options, callback)

cancelOperation(request: protos.google.longrunning.CancelOperationRequest, options?: gax.CallOptions | Callback<protos.google.protobuf.Empty, protos.google.longrunning.CancelOperationRequest, {} | 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.

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

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

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

checkCreateEdgeSlmProgress(name)

checkCreateEdgeSlmProgress(name: string): Promise<LROperation<protos.google.cloud.telcoautomation.v1alpha1.EdgeSlm, protos.google.cloud.telcoautomation.v1alpha1.OperationMetadata>>;

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

Parameter
Name Description
name string

The operation name that will be passed.

Returns
Type Description
Promise<LROperation<protos.google.cloud.telcoautomation.v1alpha1.EdgeSlm, protos.google.cloud.telcoautomation.v1alpha1.OperationMetadata>>

{Promise} - The promise which resolves to an object. The decoded operation object has result and metadata field to get information from. Please see the documentation for more details and examples.

Example

  /**
   * This snippet has been automatically generated and should be regarded as a code template only.
   * It will require modifications to work.
   * It may require correct/in-range values for request initialization.
   * TODO(developer): Uncomment these variables before running the sample.
   */
  /**
   *  Required. Value for parent.
   */
  // const parent = 'abc123'
  /**
   *  Required. Id of the requesting object
   *  If auto-generating Id server-side, remove this field and
   *  edge_slm_id from the method_signature of Create RPC
   */
  // const edgeSlmId = 'abc123'
  /**
   *  Required. The resource being created
   */
  // const edgeSlm = {}
  /**
   *  Optional. An optional 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 Telcoautomation library
  const {TelcoAutomationClient} = require('@google-cloud/telcoautomation').v1alpha1;

  // Instantiates a client
  const telcoautomationClient = new TelcoAutomationClient();

  async function callCreateEdgeSlm() {
    // Construct request
    const request = {
      parent,
      edgeSlmId,
      edgeSlm,
    };

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

  callCreateEdgeSlm();

checkCreateOrchestrationClusterProgress(name)

checkCreateOrchestrationClusterProgress(name: string): Promise<LROperation<protos.google.cloud.telcoautomation.v1alpha1.OrchestrationCluster, protos.google.cloud.telcoautomation.v1alpha1.OperationMetadata>>;

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

Parameter
Name Description
name string

The operation name that will be passed.

Returns
Type Description
Promise<LROperation<protos.google.cloud.telcoautomation.v1alpha1.OrchestrationCluster, protos.google.cloud.telcoautomation.v1alpha1.OperationMetadata>>

{Promise} - The promise which resolves to an object. The decoded operation object has result and metadata field to get information from. Please see the documentation for more details and examples.

Example

  /**
   * This snippet has been automatically generated and should be regarded as a code template only.
   * It will require modifications to work.
   * It may require correct/in-range values for request initialization.
   * TODO(developer): Uncomment these variables before running the sample.
   */
  /**
   *  Required. Value for parent.
   */
  // const parent = 'abc123'
  /**
   *  Required. Id of the requesting object
   *  If auto-generating Id server-side, remove this field and
   *  orchestration_cluster_id from the method_signature of Create RPC
   */
  // const orchestrationClusterId = 'abc123'
  /**
   *  Required. The resource being created
   */
  // const orchestrationCluster = {}
  /**
   *  Optional. An optional 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 Telcoautomation library
  const {TelcoAutomationClient} = require('@google-cloud/telcoautomation').v1alpha1;

  // Instantiates a client
  const telcoautomationClient = new TelcoAutomationClient();

  async function callCreateOrchestrationCluster() {
    // Construct request
    const request = {
      parent,
      orchestrationClusterId,
      orchestrationCluster,
    };

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

  callCreateOrchestrationCluster();

checkDeleteEdgeSlmProgress(name)

checkDeleteEdgeSlmProgress(name: string): Promise<LROperation<protos.google.protobuf.Empty, protos.google.cloud.telcoautomation.v1alpha1.OperationMetadata>>;

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

Parameter
Name Description
name string

The operation name that will be passed.

Returns
Type Description
Promise<LROperation<protos.google.protobuf.Empty, protos.google.cloud.telcoautomation.v1alpha1.OperationMetadata>>

{Promise} - The promise which resolves to an object. The decoded operation object has result and metadata field to get information from. Please see the documentation for more details and examples.

Example

  /**
   * This snippet has been automatically generated and should be regarded as a code template only.
   * It will require modifications to work.
   * It may require correct/in-range values for request initialization.
   * TODO(developer): Uncomment these variables before running the sample.
   */
  /**
   *  Required. Name of the resource
   */
  // const name = 'abc123'
  /**
   *  Optional. An optional 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 Telcoautomation library
  const {TelcoAutomationClient} = require('@google-cloud/telcoautomation').v1alpha1;

  // Instantiates a client
  const telcoautomationClient = new TelcoAutomationClient();

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

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

  callDeleteEdgeSlm();

checkDeleteOrchestrationClusterProgress(name)

checkDeleteOrchestrationClusterProgress(name: string): Promise<LROperation<protos.google.protobuf.Empty, protos.google.cloud.telcoautomation.v1alpha1.OperationMetadata>>;

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

Parameter
Name Description
name string

The operation name that will be passed.

Returns
Type Description
Promise<LROperation<protos.google.protobuf.Empty, protos.google.cloud.telcoautomation.v1alpha1.OperationMetadata>>

{Promise} - The promise which resolves to an object. The decoded operation object has result and metadata field to get information from. Please see the documentation for more details and examples.

Example

  /**
   * This snippet has been automatically generated and should be regarded as a code template only.
   * It will require modifications to work.
   * It may require correct/in-range values for request initialization.
   * TODO(developer): Uncomment these variables before running the sample.
   */
  /**
   *  Required. Name of the resource
   */
  // const name = 'abc123'
  /**
   *  Optional. An optional 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 Telcoautomation library
  const {TelcoAutomationClient} = require('@google-cloud/telcoautomation').v1alpha1;

  // Instantiates a client
  const telcoautomationClient = new TelcoAutomationClient();

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

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

  callDeleteOrchestrationCluster();

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.

computeDeploymentStatus(request, options)

computeDeploymentStatus(request?: protos.google.cloud.telcoautomation.v1alpha1.IComputeDeploymentStatusRequest, options?: CallOptions): Promise<[
        protos.google.cloud.telcoautomation.v1alpha1.IComputeDeploymentStatusResponse,
        (protos.google.cloud.telcoautomation.v1alpha1.IComputeDeploymentStatusRequest | undefined),
        {} | undefined
    ]>;

Returns the requested deployment status.

Parameters
Name Description
request IComputeDeploymentStatusRequest

The request object that will be sent.

options CallOptions

Call options. See CallOptions for more details.

Returns
Type Description
Promise<[ protos.google.cloud.telcoautomation.v1alpha1.IComputeDeploymentStatusResponse, (protos.google.cloud.telcoautomation.v1alpha1.IComputeDeploymentStatusRequest | undefined), {} | undefined ]>

{Promise} - The promise which resolves to an array. The first element of the array is an object representing ComputeDeploymentStatusResponse. 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 deployment without revisionID.
   */
  // const name = 'abc123'

  // Imports the Telcoautomation library
  const {TelcoAutomationClient} = require('@google-cloud/telcoautomation').v1alpha1;

  // Instantiates a client
  const telcoautomationClient = new TelcoAutomationClient();

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

    // Run request
    const response = await telcoautomationClient.computeDeploymentStatus(request);
    console.log(response);
  }

  callComputeDeploymentStatus();

computeDeploymentStatus(request, options, callback)

computeDeploymentStatus(request: protos.google.cloud.telcoautomation.v1alpha1.IComputeDeploymentStatusRequest, options: CallOptions, callback: Callback<protos.google.cloud.telcoautomation.v1alpha1.IComputeDeploymentStatusResponse, protos.google.cloud.telcoautomation.v1alpha1.IComputeDeploymentStatusRequest | null | undefined, {} | null | undefined>): void;
Parameters
Name Description
request IComputeDeploymentStatusRequest
options CallOptions
callback Callback<protos.google.cloud.telcoautomation.v1alpha1.IComputeDeploymentStatusResponse, protos.google.cloud.telcoautomation.v1alpha1.IComputeDeploymentStatusRequest | null | undefined, {} | null | undefined>
Returns
Type Description
void

computeDeploymentStatus(request, callback)

computeDeploymentStatus(request: protos.google.cloud.telcoautomation.v1alpha1.IComputeDeploymentStatusRequest, callback: Callback<protos.google.cloud.telcoautomation.v1alpha1.IComputeDeploymentStatusResponse, protos.google.cloud.telcoautomation.v1alpha1.IComputeDeploymentStatusRequest | null | undefined, {} | null | undefined>): void;
Parameters
Name Description
request IComputeDeploymentStatusRequest
callback Callback<protos.google.cloud.telcoautomation.v1alpha1.IComputeDeploymentStatusResponse, protos.google.cloud.telcoautomation.v1alpha1.IComputeDeploymentStatusRequest | null | undefined, {} | null | undefined>
Returns
Type Description
void

createBlueprint(request, options)

createBlueprint(request?: protos.google.cloud.telcoautomation.v1alpha1.ICreateBlueprintRequest, options?: CallOptions): Promise<[
        protos.google.cloud.telcoautomation.v1alpha1.IBlueprint,
        (protos.google.cloud.telcoautomation.v1alpha1.ICreateBlueprintRequest | undefined),
        {} | undefined
    ]>;

Creates a blueprint.

Parameters
Name Description
request ICreateBlueprintRequest

The request object that will be sent.

options CallOptions

Call options. See CallOptions for more details.

Returns
Type Description
Promise<[ protos.google.cloud.telcoautomation.v1alpha1.IBlueprint, (protos.google.cloud.telcoautomation.v1alpha1.ICreateBlueprintRequest | 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 parent resource.
   *  Format should be -
   *  "projects/{project_id}/locations/{location_name}/orchestrationClusters/{orchestration_cluster}".
   */
  // const parent = 'abc123'
  /**
   *  Optional. The name of the blueprint.
   */
  // const blueprintId = 'abc123'
  /**
   *  Required. The `Blueprint` to create.
   */
  // const blueprint = {}

  // Imports the Telcoautomation library
  const {TelcoAutomationClient} = require('@google-cloud/telcoautomation').v1alpha1;

  // Instantiates a client
  const telcoautomationClient = new TelcoAutomationClient();

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

    // Run request
    const response = await telcoautomationClient.createBlueprint(request);
    console.log(response);
  }

  callCreateBlueprint();

createBlueprint(request, options, callback)

createBlueprint(request: protos.google.cloud.telcoautomation.v1alpha1.ICreateBlueprintRequest, options: CallOptions, callback: Callback<protos.google.cloud.telcoautomation.v1alpha1.IBlueprint, protos.google.cloud.telcoautomation.v1alpha1.ICreateBlueprintRequest | null | undefined, {} | null | undefined>): void;
Parameters
Name Description
request ICreateBlueprintRequest
options CallOptions
callback Callback<protos.google.cloud.telcoautomation.v1alpha1.IBlueprint, protos.google.cloud.telcoautomation.v1alpha1.ICreateBlueprintRequest | null | undefined, {} | null | undefined>
Returns
Type Description
void

createBlueprint(request, callback)

createBlueprint(request: protos.google.cloud.telcoautomation.v1alpha1.ICreateBlueprintRequest, callback: Callback<protos.google.cloud.telcoautomation.v1alpha1.IBlueprint, protos.google.cloud.telcoautomation.v1alpha1.ICreateBlueprintRequest | null | undefined, {} | null | undefined>): void;
Parameters
Name Description
request ICreateBlueprintRequest
callback Callback<protos.google.cloud.telcoautomation.v1alpha1.IBlueprint, protos.google.cloud.telcoautomation.v1alpha1.ICreateBlueprintRequest | null | undefined, {} | null | undefined>
Returns
Type Description
void

createDeployment(request, options)

createDeployment(request?: protos.google.cloud.telcoautomation.v1alpha1.ICreateDeploymentRequest, options?: CallOptions): Promise<[
        protos.google.cloud.telcoautomation.v1alpha1.IDeployment,
        (protos.google.cloud.telcoautomation.v1alpha1.ICreateDeploymentRequest | undefined),
        {} | undefined
    ]>;

Creates a deployment.

Parameters
Name Description
request ICreateDeploymentRequest

The request object that will be sent.

options CallOptions

Call options. See CallOptions for more details.

Returns
Type Description
Promise<[ protos.google.cloud.telcoautomation.v1alpha1.IDeployment, (protos.google.cloud.telcoautomation.v1alpha1.ICreateDeploymentRequest | 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 parent resource.
   *  Format should be -
   *  "projects/{project_id}/locations/{location_name}/orchestrationClusters/{orchestration_cluster}".
   */
  // const parent = 'abc123'
  /**
   *  Optional. The name of the deployment.
   */
  // const deploymentId = 'abc123'
  /**
   *  Required. The `Deployment` to create.
   */
  // const deployment = {}

  // Imports the Telcoautomation library
  const {TelcoAutomationClient} = require('@google-cloud/telcoautomation').v1alpha1;

  // Instantiates a client
  const telcoautomationClient = new TelcoAutomationClient();

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

    // Run request
    const response = await telcoautomationClient.createDeployment(request);
    console.log(response);
  }

  callCreateDeployment();

createDeployment(request, options, callback)

createDeployment(request: protos.google.cloud.telcoautomation.v1alpha1.ICreateDeploymentRequest, options: CallOptions, callback: Callback<protos.google.cloud.telcoautomation.v1alpha1.IDeployment, protos.google.cloud.telcoautomation.v1alpha1.ICreateDeploymentRequest | null | undefined, {} | null | undefined>): void;
Parameters
Name Description
request ICreateDeploymentRequest
options CallOptions
callback Callback<protos.google.cloud.telcoautomation.v1alpha1.IDeployment, protos.google.cloud.telcoautomation.v1alpha1.ICreateDeploymentRequest | null | undefined, {} | null | undefined>
Returns
Type Description
void

createDeployment(request, callback)

createDeployment(request: protos.google.cloud.telcoautomation.v1alpha1.ICreateDeploymentRequest, callback: Callback<protos.google.cloud.telcoautomation.v1alpha1.IDeployment, protos.google.cloud.telcoautomation.v1alpha1.ICreateDeploymentRequest | null | undefined, {} | null | undefined>): void;
Parameters
Name Description
request ICreateDeploymentRequest
callback Callback<protos.google.cloud.telcoautomation.v1alpha1.IDeployment, protos.google.cloud.telcoautomation.v1alpha1.ICreateDeploymentRequest | null | undefined, {} | null | undefined>
Returns
Type Description
void

createEdgeSlm(request, options)

createEdgeSlm(request?: protos.google.cloud.telcoautomation.v1alpha1.ICreateEdgeSlmRequest, options?: CallOptions): Promise<[
        LROperation<protos.google.cloud.telcoautomation.v1alpha1.IEdgeSlm, protos.google.cloud.telcoautomation.v1alpha1.IOperationMetadata>,
        protos.google.longrunning.IOperation | undefined,
        {} | undefined
    ]>;

Creates a new EdgeSlm in a given project and location.

Parameters
Name Description
request ICreateEdgeSlmRequest

The request object that will be sent.

options CallOptions

Call options. See CallOptions for more details.

Returns
Type Description
Promise<[ LROperation<protos.google.cloud.telcoautomation.v1alpha1.IEdgeSlm, protos.google.cloud.telcoautomation.v1alpha1.IOperationMetadata>, protos.google.longrunning.IOperation | undefined, {} | undefined ]>

{Promise} - The promise which resolves to an array. The first element of the array is an object representing a long running operation. Its promise() method returns a promise you can await for. Please see the documentation for more details and examples.

Example

  /**
   * This snippet has been automatically generated and should be regarded as a code template only.
   * It will require modifications to work.
   * It may require correct/in-range values for request initialization.
   * TODO(developer): Uncomment these variables before running the sample.
   */
  /**
   *  Required. Value for parent.
   */
  // const parent = 'abc123'
  /**
   *  Required. Id of the requesting object
   *  If auto-generating Id server-side, remove this field and
   *  edge_slm_id from the method_signature of Create RPC
   */
  // const edgeSlmId = 'abc123'
  /**
   *  Required. The resource being created
   */
  // const edgeSlm = {}
  /**
   *  Optional. An optional 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 Telcoautomation library
  const {TelcoAutomationClient} = require('@google-cloud/telcoautomation').v1alpha1;

  // Instantiates a client
  const telcoautomationClient = new TelcoAutomationClient();

  async function callCreateEdgeSlm() {
    // Construct request
    const request = {
      parent,
      edgeSlmId,
      edgeSlm,
    };

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

  callCreateEdgeSlm();

createEdgeSlm(request, options, callback)

createEdgeSlm(request: protos.google.cloud.telcoautomation.v1alpha1.ICreateEdgeSlmRequest, options: CallOptions, callback: Callback<LROperation<protos.google.cloud.telcoautomation.v1alpha1.IEdgeSlm, protos.google.cloud.telcoautomation.v1alpha1.IOperationMetadata>, protos.google.longrunning.IOperation | null | undefined, {} | null | undefined>): void;
Parameters
Name Description
request ICreateEdgeSlmRequest
options CallOptions
callback Callback<LROperation<protos.google.cloud.telcoautomation.v1alpha1.IEdgeSlm, protos.google.cloud.telcoautomation.v1alpha1.IOperationMetadata>, protos.google.longrunning.IOperation | null | undefined, {} | null | undefined>
Returns
Type Description
void

createEdgeSlm(request, callback)

createEdgeSlm(request: protos.google.cloud.telcoautomation.v1alpha1.ICreateEdgeSlmRequest, callback: Callback<LROperation<protos.google.cloud.telcoautomation.v1alpha1.IEdgeSlm, protos.google.cloud.telcoautomation.v1alpha1.IOperationMetadata>, protos.google.longrunning.IOperation | null | undefined, {} | null | undefined>): void;
Parameters
Name Description
request ICreateEdgeSlmRequest
callback Callback<LROperation<protos.google.cloud.telcoautomation.v1alpha1.IEdgeSlm, protos.google.cloud.telcoautomation.v1alpha1.IOperationMetadata>, protos.google.longrunning.IOperation | null | undefined, {} | null | undefined>
Returns
Type Description
void

createOrchestrationCluster(request, options)

createOrchestrationCluster(request?: protos.google.cloud.telcoautomation.v1alpha1.ICreateOrchestrationClusterRequest, options?: CallOptions): Promise<[
        LROperation<protos.google.cloud.telcoautomation.v1alpha1.IOrchestrationCluster, protos.google.cloud.telcoautomation.v1alpha1.IOperationMetadata>,
        protos.google.longrunning.IOperation | undefined,
        {} | undefined
    ]>;

Creates a new OrchestrationCluster in a given project and location.

Parameters
Name Description
request ICreateOrchestrationClusterRequest

The request object that will be sent.

options CallOptions

Call options. See CallOptions for more details.

Returns
Type Description
Promise<[ LROperation<protos.google.cloud.telcoautomation.v1alpha1.IOrchestrationCluster, protos.google.cloud.telcoautomation.v1alpha1.IOperationMetadata>, protos.google.longrunning.IOperation | undefined, {} | undefined ]>

{Promise} - The promise which resolves to an array. The first element of the array is an object representing a long running operation. Its promise() method returns a promise you can await for. Please see the documentation for more details and examples.

Example

  /**
   * This snippet has been automatically generated and should be regarded as a code template only.
   * It will require modifications to work.
   * It may require correct/in-range values for request initialization.
   * TODO(developer): Uncomment these variables before running the sample.
   */
  /**
   *  Required. Value for parent.
   */
  // const parent = 'abc123'
  /**
   *  Required. Id of the requesting object
   *  If auto-generating Id server-side, remove this field and
   *  orchestration_cluster_id from the method_signature of Create RPC
   */
  // const orchestrationClusterId = 'abc123'
  /**
   *  Required. The resource being created
   */
  // const orchestrationCluster = {}
  /**
   *  Optional. An optional 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 Telcoautomation library
  const {TelcoAutomationClient} = require('@google-cloud/telcoautomation').v1alpha1;

  // Instantiates a client
  const telcoautomationClient = new TelcoAutomationClient();

  async function callCreateOrchestrationCluster() {
    // Construct request
    const request = {
      parent,
      orchestrationClusterId,
      orchestrationCluster,
    };

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

  callCreateOrchestrationCluster();

createOrchestrationCluster(request, options, callback)

createOrchestrationCluster(request: protos.google.cloud.telcoautomation.v1alpha1.ICreateOrchestrationClusterRequest, options: CallOptions, callback: Callback<LROperation<protos.google.cloud.telcoautomation.v1alpha1.IOrchestrationCluster, protos.google.cloud.telcoautomation.v1alpha1.IOperationMetadata>, protos.google.longrunning.IOperation | null | undefined, {} | null | undefined>): void;
Parameters
Name Description
request ICreateOrchestrationClusterRequest
options CallOptions
callback Callback<LROperation<protos.google.cloud.telcoautomation.v1alpha1.IOrchestrationCluster, protos.google.cloud.telcoautomation.v1alpha1.IOperationMetadata>, protos.google.longrunning.IOperation | null | undefined, {} | null | undefined>
Returns
Type Description
void

createOrchestrationCluster(request, callback)

createOrchestrationCluster(request: protos.google.cloud.telcoautomation.v1alpha1.ICreateOrchestrationClusterRequest, callback: Callback<LROperation<protos.google.cloud.telcoautomation.v1alpha1.IOrchestrationCluster, protos.google.cloud.telcoautomation.v1alpha1.IOperationMetadata>, protos.google.longrunning.IOperation | null | undefined, {} | null | undefined>): void;
Parameters
Name Description
request ICreateOrchestrationClusterRequest
callback Callback<LROperation<protos.google.cloud.telcoautomation.v1alpha1.IOrchestrationCluster, protos.google.cloud.telcoautomation.v1alpha1.IOperationMetadata>, protos.google.longrunning.IOperation | null | undefined, {} | null | undefined>
Returns
Type Description
void

deleteBlueprint(request, options)

deleteBlueprint(request?: protos.google.cloud.telcoautomation.v1alpha1.IDeleteBlueprintRequest, options?: CallOptions): Promise<[
        protos.google.protobuf.IEmpty,
        (protos.google.cloud.telcoautomation.v1alpha1.IDeleteBlueprintRequest | undefined),
        {} | undefined
    ]>;

Deletes a blueprint and all its revisions.

Parameters
Name Description
request IDeleteBlueprintRequest

The request object that will be sent.

options CallOptions

Call options. See CallOptions for more details.

Returns
Type Description
Promise<[ protos.google.protobuf.IEmpty, (protos.google.cloud.telcoautomation.v1alpha1.IDeleteBlueprintRequest | undefined), {} | undefined ]>

{Promise} - The promise which resolves to an array. The first element of the array is an object representing Empty. 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 blueprint to delete.
   *  Blueprint name should be in the format {blueprint_id}, if
   *  {blueprint_id}@{revision_id} is passed then the API throws invalid
   *  argument.
   */
  // const name = 'abc123'

  // Imports the Telcoautomation library
  const {TelcoAutomationClient} = require('@google-cloud/telcoautomation').v1alpha1;

  // Instantiates a client
  const telcoautomationClient = new TelcoAutomationClient();

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

    // Run request
    const response = await telcoautomationClient.deleteBlueprint(request);
    console.log(response);
  }

  callDeleteBlueprint();

deleteBlueprint(request, options, callback)

deleteBlueprint(request: protos.google.cloud.telcoautomation.v1alpha1.IDeleteBlueprintRequest, options: CallOptions, callback: Callback<protos.google.protobuf.IEmpty, protos.google.cloud.telcoautomation.v1alpha1.IDeleteBlueprintRequest | null | undefined, {} | null | undefined>): void;
Parameters
Name Description
request IDeleteBlueprintRequest
options CallOptions
callback Callback<protos.google.protobuf.IEmpty, protos.google.cloud.telcoautomation.v1alpha1.IDeleteBlueprintRequest | null | undefined, {} | null | undefined>
Returns
Type Description
void

deleteBlueprint(request, callback)

deleteBlueprint(request: protos.google.cloud.telcoautomation.v1alpha1.IDeleteBlueprintRequest, callback: Callback<protos.google.protobuf.IEmpty, protos.google.cloud.telcoautomation.v1alpha1.IDeleteBlueprintRequest | null | undefined, {} | null | undefined>): void;
Parameters
Name Description
request IDeleteBlueprintRequest
callback Callback<protos.google.protobuf.IEmpty, protos.google.cloud.telcoautomation.v1alpha1.IDeleteBlueprintRequest | null | undefined, {} | null | undefined>
Returns
Type Description
void

deleteEdgeSlm(request, options)

deleteEdgeSlm(request?: protos.google.cloud.telcoautomation.v1alpha1.IDeleteEdgeSlmRequest, options?: CallOptions): Promise<[
        LROperation<protos.google.protobuf.IEmpty, protos.google.cloud.telcoautomation.v1alpha1.IOperationMetadata>,
        protos.google.longrunning.IOperation | undefined,
        {} | undefined
    ]>;

Deletes a single EdgeSlm.

Parameters
Name Description
request IDeleteEdgeSlmRequest

The request object that will be sent.

options CallOptions

Call options. See CallOptions for more details.

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

{Promise} - The promise which resolves to an array. The first element of the array is an object representing a long running operation. Its promise() method returns a promise you can await for. Please see the documentation for more details and examples.

Example

  /**
   * This snippet has been automatically generated and should be regarded as a code template only.
   * It will require modifications to work.
   * It may require correct/in-range values for request initialization.
   * TODO(developer): Uncomment these variables before running the sample.
   */
  /**
   *  Required. Name of the resource
   */
  // const name = 'abc123'
  /**
   *  Optional. An optional 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 Telcoautomation library
  const {TelcoAutomationClient} = require('@google-cloud/telcoautomation').v1alpha1;

  // Instantiates a client
  const telcoautomationClient = new TelcoAutomationClient();

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

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

  callDeleteEdgeSlm();

deleteEdgeSlm(request, options, callback)

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

deleteEdgeSlm(request, callback)

deleteEdgeSlm(request: protos.google.cloud.telcoautomation.v1alpha1.IDeleteEdgeSlmRequest, callback: Callback<LROperation<protos.google.protobuf.IEmpty, protos.google.cloud.telcoautomation.v1alpha1.IOperationMetadata>, protos.google.longrunning.IOperation | null | undefined, {} | null | undefined>): void;
Parameters
Name Description
request IDeleteEdgeSlmRequest
callback Callback<LROperation<protos.google.protobuf.IEmpty, protos.google.cloud.telcoautomation.v1alpha1.IOperationMetadata>, protos.google.longrunning.IOperation | null | undefined, {} | null | undefined>
Returns
Type Description
void

deleteOperation(request, options, callback)

deleteOperation(request: protos.google.longrunning.DeleteOperationRequest, options?: 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.

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

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

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

deleteOrchestrationCluster(request, options)

deleteOrchestrationCluster(request?: protos.google.cloud.telcoautomation.v1alpha1.IDeleteOrchestrationClusterRequest, options?: CallOptions): Promise<[
        LROperation<protos.google.protobuf.IEmpty, protos.google.cloud.telcoautomation.v1alpha1.IOperationMetadata>,
        protos.google.longrunning.IOperation | undefined,
        {} | undefined
    ]>;

Deletes a single OrchestrationCluster.

Parameters
Name Description
request IDeleteOrchestrationClusterRequest

The request object that will be sent.

options CallOptions

Call options. See CallOptions for more details.

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

{Promise} - The promise which resolves to an array. The first element of the array is an object representing a long running operation. Its promise() method returns a promise you can await for. Please see the documentation for more details and examples.

Example

  /**
   * This snippet has been automatically generated and should be regarded as a code template only.
   * It will require modifications to work.
   * It may require correct/in-range values for request initialization.
   * TODO(developer): Uncomment these variables before running the sample.
   */
  /**
   *  Required. Name of the resource
   */
  // const name = 'abc123'
  /**
   *  Optional. An optional 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 Telcoautomation library
  const {TelcoAutomationClient} = require('@google-cloud/telcoautomation').v1alpha1;

  // Instantiates a client
  const telcoautomationClient = new TelcoAutomationClient();

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

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

  callDeleteOrchestrationCluster();

deleteOrchestrationCluster(request, options, callback)

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

deleteOrchestrationCluster(request, callback)

deleteOrchestrationCluster(request: protos.google.cloud.telcoautomation.v1alpha1.IDeleteOrchestrationClusterRequest, callback: Callback<LROperation<protos.google.protobuf.IEmpty, protos.google.cloud.telcoautomation.v1alpha1.IOperationMetadata>, protos.google.longrunning.IOperation | null | undefined, {} | null | undefined>): void;
Parameters
Name Description
request IDeleteOrchestrationClusterRequest
callback Callback<LROperation<protos.google.protobuf.IEmpty, protos.google.cloud.telcoautomation.v1alpha1.IOperationMetadata>, protos.google.longrunning.IOperation | null | undefined, {} | null | undefined>
Returns
Type Description
void

deploymentPath(project, location, orchestrationCluster, deployment)

deploymentPath(project: string, location: string, orchestrationCluster: string, deployment: string): string;

Return a fully-qualified deployment resource name string.

Parameters
Name Description
project string
location string
orchestrationCluster string
deployment string
Returns
Type Description
string

{string} Resource name string.

discardBlueprintChanges(request, options)

discardBlueprintChanges(request?: protos.google.cloud.telcoautomation.v1alpha1.IDiscardBlueprintChangesRequest, options?: CallOptions): Promise<[
        protos.google.cloud.telcoautomation.v1alpha1.IDiscardBlueprintChangesResponse,
        (protos.google.cloud.telcoautomation.v1alpha1.IDiscardBlueprintChangesRequest | undefined),
        {} | undefined
    ]>;

Discards the changes in a blueprint and reverts the blueprint to the last approved blueprint revision. No changes take place if a blueprint does not have revisions.

Parameters
Name Description
request IDiscardBlueprintChangesRequest

The request object that will be sent.

options CallOptions

Call options. See CallOptions for more details.

Returns
Type Description
Promise<[ protos.google.cloud.telcoautomation.v1alpha1.IDiscardBlueprintChangesResponse, (protos.google.cloud.telcoautomation.v1alpha1.IDiscardBlueprintChangesRequest | undefined), {} | undefined ]>

{Promise} - The promise which resolves to an array. The first element of the array is an object representing DiscardBlueprintChangesResponse. 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 blueprint of which changes are being discarded.
   */
  // const name = 'abc123'

  // Imports the Telcoautomation library
  const {TelcoAutomationClient} = require('@google-cloud/telcoautomation').v1alpha1;

  // Instantiates a client
  const telcoautomationClient = new TelcoAutomationClient();

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

    // Run request
    const response = await telcoautomationClient.discardBlueprintChanges(request);
    console.log(response);
  }

  callDiscardBlueprintChanges();

discardBlueprintChanges(request, options, callback)

discardBlueprintChanges(request: protos.google.cloud.telcoautomation.v1alpha1.IDiscardBlueprintChangesRequest, options: CallOptions, callback: Callback<protos.google.cloud.telcoautomation.v1alpha1.IDiscardBlueprintChangesResponse, protos.google.cloud.telcoautomation.v1alpha1.IDiscardBlueprintChangesRequest | null | undefined, {} | null | undefined>): void;
Parameters
Name Description
request IDiscardBlueprintChangesRequest
options CallOptions
callback Callback<protos.google.cloud.telcoautomation.v1alpha1.IDiscardBlueprintChangesResponse, protos.google.cloud.telcoautomation.v1alpha1.IDiscardBlueprintChangesRequest | null | undefined, {} | null | undefined>
Returns
Type Description
void

discardBlueprintChanges(request, callback)

discardBlueprintChanges(request: protos.google.cloud.telcoautomation.v1alpha1.IDiscardBlueprintChangesRequest, callback: Callback<protos.google.cloud.telcoautomation.v1alpha1.IDiscardBlueprintChangesResponse, protos.google.cloud.telcoautomation.v1alpha1.IDiscardBlueprintChangesRequest | null | undefined, {} | null | undefined>): void;
Parameters
Name Description
request IDiscardBlueprintChangesRequest
callback Callback<protos.google.cloud.telcoautomation.v1alpha1.IDiscardBlueprintChangesResponse, protos.google.cloud.telcoautomation.v1alpha1.IDiscardBlueprintChangesRequest | null | undefined, {} | null | undefined>
Returns
Type Description
void

discardDeploymentChanges(request, options)

discardDeploymentChanges(request?: protos.google.cloud.telcoautomation.v1alpha1.IDiscardDeploymentChangesRequest, options?: CallOptions): Promise<[
        protos.google.cloud.telcoautomation.v1alpha1.IDiscardDeploymentChangesResponse,
        (protos.google.cloud.telcoautomation.v1alpha1.IDiscardDeploymentChangesRequest | undefined),
        {} | undefined
    ]>;

Discards the changes in a deployment and reverts the deployment to the last approved deployment revision. No changes take place if a deployment does not have revisions.

Parameters
Name Description
request IDiscardDeploymentChangesRequest

The request object that will be sent.

options CallOptions

Call options. See CallOptions for more details.

Returns
Type Description
Promise<[ protos.google.cloud.telcoautomation.v1alpha1.IDiscardDeploymentChangesResponse, (protos.google.cloud.telcoautomation.v1alpha1.IDiscardDeploymentChangesRequest | undefined), {} | undefined ]>

{Promise} - The promise which resolves to an array. The first element of the array is an object representing DiscardDeploymentChangesResponse. 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 deployment of which changes are being discarded.
   */
  // const name = 'abc123'

  // Imports the Telcoautomation library
  const {TelcoAutomationClient} = require('@google-cloud/telcoautomation').v1alpha1;

  // Instantiates a client
  const telcoautomationClient = new TelcoAutomationClient();

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

    // Run request
    const response = await telcoautomationClient.discardDeploymentChanges(request);
    console.log(response);
  }

  callDiscardDeploymentChanges();

discardDeploymentChanges(request, options, callback)

discardDeploymentChanges(request: protos.google.cloud.telcoautomation.v1alpha1.IDiscardDeploymentChangesRequest, options: CallOptions, callback: Callback<protos.google.cloud.telcoautomation.v1alpha1.IDiscardDeploymentChangesResponse, protos.google.cloud.telcoautomation.v1alpha1.IDiscardDeploymentChangesRequest | null | undefined, {} | null | undefined>): void;
Parameters
Name Description
request IDiscardDeploymentChangesRequest
options CallOptions
callback Callback<protos.google.cloud.telcoautomation.v1alpha1.IDiscardDeploymentChangesResponse, protos.google.cloud.telcoautomation.v1alpha1.IDiscardDeploymentChangesRequest | null | undefined, {} | null | undefined>
Returns
Type Description
void

discardDeploymentChanges(request, callback)

discardDeploymentChanges(request: protos.google.cloud.telcoautomation.v1alpha1.IDiscardDeploymentChangesRequest, callback: Callback<protos.google.cloud.telcoautomation.v1alpha1.IDiscardDeploymentChangesResponse, protos.google.cloud.telcoautomation.v1alpha1.IDiscardDeploymentChangesRequest | null | undefined, {} | null | undefined>): void;
Parameters
Name Description
request IDiscardDeploymentChangesRequest
callback Callback<protos.google.cloud.telcoautomation.v1alpha1.IDiscardDeploymentChangesResponse, protos.google.cloud.telcoautomation.v1alpha1.IDiscardDeploymentChangesRequest | null | undefined, {} | null | undefined>
Returns
Type Description
void

edgeSlmPath(project, location, edgeSlm)

edgeSlmPath(project: string, location: string, edgeSlm: string): string;

Return a fully-qualified edgeSlm resource name string.

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

{string} Resource name string.

getBlueprint(request, options)

getBlueprint(request?: protos.google.cloud.telcoautomation.v1alpha1.IGetBlueprintRequest, options?: CallOptions): Promise<[
        protos.google.cloud.telcoautomation.v1alpha1.IBlueprint,
        (protos.google.cloud.telcoautomation.v1alpha1.IGetBlueprintRequest | undefined),
        {} | undefined
    ]>;

Returns the requested blueprint.

Parameters
Name Description
request IGetBlueprintRequest

The request object that will be sent.

options CallOptions

Call options. See CallOptions for more details.

Returns
Type Description
Promise<[ protos.google.cloud.telcoautomation.v1alpha1.IBlueprint, (protos.google.cloud.telcoautomation.v1alpha1.IGetBlueprintRequest | 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 blueprint.
   *  Case 1: If the name provided in the request is
   *  {blueprint_id}@{revision_id}, then the revision with revision_id will be
   *  returned. Case 2: If the name provided in the request is {blueprint}, then
   *  the current state of the blueprint is returned.
   */
  // const name = 'abc123'
  /**
   *  Optional. Defines the type of view of the blueprint.
   *  When field is not present BLUEPRINT_VIEW_BASIC is considered as default.
   */
  // const view = {}

  // Imports the Telcoautomation library
  const {TelcoAutomationClient} = require('@google-cloud/telcoautomation').v1alpha1;

  // Instantiates a client
  const telcoautomationClient = new TelcoAutomationClient();

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

    // Run request
    const response = await telcoautomationClient.getBlueprint(request);
    console.log(response);
  }

  callGetBlueprint();

getBlueprint(request, options, callback)

getBlueprint(request: protos.google.cloud.telcoautomation.v1alpha1.IGetBlueprintRequest, options: CallOptions, callback: Callback<protos.google.cloud.telcoautomation.v1alpha1.IBlueprint, protos.google.cloud.telcoautomation.v1alpha1.IGetBlueprintRequest | null | undefined, {} | null | undefined>): void;
Parameters
Name Description
request IGetBlueprintRequest
options CallOptions
callback Callback<protos.google.cloud.telcoautomation.v1alpha1.IBlueprint, protos.google.cloud.telcoautomation.v1alpha1.IGetBlueprintRequest | null | undefined, {} | null | undefined>
Returns
Type Description
void

getBlueprint(request, callback)

getBlueprint(request: protos.google.cloud.telcoautomation.v1alpha1.IGetBlueprintRequest, callback: Callback<protos.google.cloud.telcoautomation.v1alpha1.IBlueprint, protos.google.cloud.telcoautomation.v1alpha1.IGetBlueprintRequest | null | undefined, {} | null | undefined>): void;
Parameters
Name Description
request IGetBlueprintRequest
callback Callback<protos.google.cloud.telcoautomation.v1alpha1.IBlueprint, protos.google.cloud.telcoautomation.v1alpha1.IGetBlueprintRequest | null | undefined, {} | null | undefined>
Returns
Type Description
void

getDeployment(request, options)

getDeployment(request?: protos.google.cloud.telcoautomation.v1alpha1.IGetDeploymentRequest, options?: CallOptions): Promise<[
        protos.google.cloud.telcoautomation.v1alpha1.IDeployment,
        (protos.google.cloud.telcoautomation.v1alpha1.IGetDeploymentRequest | undefined),
        {} | undefined
    ]>;

Returns the requested deployment.

Parameters
Name Description
request IGetDeploymentRequest

The request object that will be sent.

options CallOptions

Call options. See CallOptions for more details.

Returns
Type Description
Promise<[ protos.google.cloud.telcoautomation.v1alpha1.IDeployment, (protos.google.cloud.telcoautomation.v1alpha1.IGetDeploymentRequest | 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 deployment.
   *  Case 1: If the name provided in the request is
   *  {deployment_id}@{revision_id}, then the revision with revision_id will be
   *  returned.
   *  Case 2: If the name provided in the request is {deployment}, then
   *  the current state of the deployment is returned.
   */
  // const name = 'abc123'
  /**
   *  Optional. Defines the type of view of the deployment.
   *  When field is not present VIEW_BASIC is considered as default.
   */
  // const view = {}

  // Imports the Telcoautomation library
  const {TelcoAutomationClient} = require('@google-cloud/telcoautomation').v1alpha1;

  // Instantiates a client
  const telcoautomationClient = new TelcoAutomationClient();

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

    // Run request
    const response = await telcoautomationClient.getDeployment(request);
    console.log(response);
  }

  callGetDeployment();

getDeployment(request, options, callback)

getDeployment(request: protos.google.cloud.telcoautomation.v1alpha1.IGetDeploymentRequest, options: CallOptions, callback: Callback<protos.google.cloud.telcoautomation.v1alpha1.IDeployment, protos.google.cloud.telcoautomation.v1alpha1.IGetDeploymentRequest | null | undefined, {} | null | undefined>): void;
Parameters
Name Description
request IGetDeploymentRequest
options CallOptions
callback Callback<protos.google.cloud.telcoautomation.v1alpha1.IDeployment, protos.google.cloud.telcoautomation.v1alpha1.IGetDeploymentRequest | null | undefined, {} | null | undefined>
Returns
Type Description
void

getDeployment(request, callback)

getDeployment(request: protos.google.cloud.telcoautomation.v1alpha1.IGetDeploymentRequest, callback: Callback<protos.google.cloud.telcoautomation.v1alpha1.IDeployment, protos.google.cloud.telcoautomation.v1alpha1.IGetDeploymentRequest | null | undefined, {} | null | undefined>): void;
Parameters
Name Description
request IGetDeploymentRequest
callback Callback<protos.google.cloud.telcoautomation.v1alpha1.IDeployment, protos.google.cloud.telcoautomation.v1alpha1.IGetDeploymentRequest | null | undefined, {} | null | undefined>
Returns
Type Description
void

getEdgeSlm(request, options)

getEdgeSlm(request?: protos.google.cloud.telcoautomation.v1alpha1.IGetEdgeSlmRequest, options?: CallOptions): Promise<[
        protos.google.cloud.telcoautomation.v1alpha1.IEdgeSlm,
        (protos.google.cloud.telcoautomation.v1alpha1.IGetEdgeSlmRequest | undefined),
        {} | undefined
    ]>;

Gets details of a single EdgeSlm.

Parameters
Name Description
request IGetEdgeSlmRequest

The request object that will be sent.

options CallOptions

Call options. See CallOptions for more details.

Returns
Type Description
Promise<[ protos.google.cloud.telcoautomation.v1alpha1.IEdgeSlm, (protos.google.cloud.telcoautomation.v1alpha1.IGetEdgeSlmRequest | undefined), {} | undefined ]>

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

Example

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

  // Imports the Telcoautomation library
  const {TelcoAutomationClient} = require('@google-cloud/telcoautomation').v1alpha1;

  // Instantiates a client
  const telcoautomationClient = new TelcoAutomationClient();

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

    // Run request
    const response = await telcoautomationClient.getEdgeSlm(request);
    console.log(response);
  }

  callGetEdgeSlm();

getEdgeSlm(request, options, callback)

getEdgeSlm(request: protos.google.cloud.telcoautomation.v1alpha1.IGetEdgeSlmRequest, options: CallOptions, callback: Callback<protos.google.cloud.telcoautomation.v1alpha1.IEdgeSlm, protos.google.cloud.telcoautomation.v1alpha1.IGetEdgeSlmRequest | null | undefined, {} | null | undefined>): void;
Parameters
Name Description
request IGetEdgeSlmRequest
options CallOptions
callback Callback<protos.google.cloud.telcoautomation.v1alpha1.IEdgeSlm, protos.google.cloud.telcoautomation.v1alpha1.IGetEdgeSlmRequest | null | undefined, {} | null | undefined>
Returns
Type Description
void

getEdgeSlm(request, callback)

getEdgeSlm(request: protos.google.cloud.telcoautomation.v1alpha1.IGetEdgeSlmRequest, callback: Callback<protos.google.cloud.telcoautomation.v1alpha1.IEdgeSlm, protos.google.cloud.telcoautomation.v1alpha1.IGetEdgeSlmRequest | null | undefined, {} | null | undefined>): void;
Parameters
Name Description
request IGetEdgeSlmRequest
callback Callback<protos.google.cloud.telcoautomation.v1alpha1.IEdgeSlm, protos.google.cloud.telcoautomation.v1alpha1.IGetEdgeSlmRequest | null | undefined, {} | null | undefined>
Returns
Type Description
void

getHydratedDeployment(request, options)

getHydratedDeployment(request?: protos.google.cloud.telcoautomation.v1alpha1.IGetHydratedDeploymentRequest, options?: CallOptions): Promise<[
        protos.google.cloud.telcoautomation.v1alpha1.IHydratedDeployment,
        (protos.google.cloud.telcoautomation.v1alpha1.IGetHydratedDeploymentRequest | undefined),
        {} | undefined
    ]>;

Returns the requested hydrated deployment.

Parameters
Name Description
request IGetHydratedDeploymentRequest

The request object that will be sent.

options CallOptions

Call options. See CallOptions for more details.

Returns
Type Description
Promise<[ protos.google.cloud.telcoautomation.v1alpha1.IHydratedDeployment, (protos.google.cloud.telcoautomation.v1alpha1.IGetHydratedDeploymentRequest | undefined), {} | undefined ]>

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

Example

  /**
   * This snippet has been automatically generated and should be regarded as a code template only.
   * It will require modifications to work.
   * It may require correct/in-range values for request initialization.
   * TODO(developer): Uncomment these variables before running the sample.
   */
  /**
   *  Required. Name of the hydrated deployment.
   */
  // const name = 'abc123'

  // Imports the Telcoautomation library
  const {TelcoAutomationClient} = require('@google-cloud/telcoautomation').v1alpha1;

  // Instantiates a client
  const telcoautomationClient = new TelcoAutomationClient();

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

    // Run request
    const response = await telcoautomationClient.getHydratedDeployment(request);
    console.log(response);
  }

  callGetHydratedDeployment();

getHydratedDeployment(request, options, callback)

getHydratedDeployment(request: protos.google.cloud.telcoautomation.v1alpha1.IGetHydratedDeploymentRequest, options: CallOptions, callback: Callback<protos.google.cloud.telcoautomation.v1alpha1.IHydratedDeployment, protos.google.cloud.telcoautomation.v1alpha1.IGetHydratedDeploymentRequest | null | undefined, {} | null | undefined>): void;
Parameters
Name Description
request IGetHydratedDeploymentRequest
options CallOptions
callback Callback<protos.google.cloud.telcoautomation.v1alpha1.IHydratedDeployment, protos.google.cloud.telcoautomation.v1alpha1.IGetHydratedDeploymentRequest | null | undefined, {} | null | undefined>
Returns
Type Description
void

getHydratedDeployment(request, callback)

getHydratedDeployment(request: protos.google.cloud.telcoautomation.v1alpha1.IGetHydratedDeploymentRequest, callback: Callback<protos.google.cloud.telcoautomation.v1alpha1.IHydratedDeployment, protos.google.cloud.telcoautomation.v1alpha1.IGetHydratedDeploymentRequest | null | undefined, {} | null | undefined>): void;
Parameters
Name Description
request IGetHydratedDeploymentRequest
callback Callback<protos.google.cloud.telcoautomation.v1alpha1.IHydratedDeployment, protos.google.cloud.telcoautomation.v1alpha1.IGetHydratedDeploymentRequest | null | undefined, {} | null | undefined>
Returns
Type Description
void

getLocation(request, options, callback)

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

Gets information about a location.

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

The request object that will be sent.

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

Call options. See CallOptions for more details.

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

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

Example

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

getOperation(request, options, callback)

getOperation(request: protos.google.longrunning.GetOperationRequest, options?: 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.

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

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

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)

getOrchestrationCluster(request, options)

getOrchestrationCluster(request?: protos.google.cloud.telcoautomation.v1alpha1.IGetOrchestrationClusterRequest, options?: CallOptions): Promise<[
        protos.google.cloud.telcoautomation.v1alpha1.IOrchestrationCluster,
        (protos.google.cloud.telcoautomation.v1alpha1.IGetOrchestrationClusterRequest | undefined),
        {} | undefined
    ]>;

Gets details of a single OrchestrationCluster.

Parameters
Name Description
request IGetOrchestrationClusterRequest

The request object that will be sent.

options CallOptions

Call options. See CallOptions for more details.

Returns
Type Description
Promise<[ protos.google.cloud.telcoautomation.v1alpha1.IOrchestrationCluster, (protos.google.cloud.telcoautomation.v1alpha1.IGetOrchestrationClusterRequest | undefined), {} | undefined ]>

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

Example

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

  // Imports the Telcoautomation library
  const {TelcoAutomationClient} = require('@google-cloud/telcoautomation').v1alpha1;

  // Instantiates a client
  const telcoautomationClient = new TelcoAutomationClient();

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

    // Run request
    const response = await telcoautomationClient.getOrchestrationCluster(request);
    console.log(response);
  }

  callGetOrchestrationCluster();

getOrchestrationCluster(request, options, callback)

getOrchestrationCluster(request: protos.google.cloud.telcoautomation.v1alpha1.IGetOrchestrationClusterRequest, options: CallOptions, callback: Callback<protos.google.cloud.telcoautomation.v1alpha1.IOrchestrationCluster, protos.google.cloud.telcoautomation.v1alpha1.IGetOrchestrationClusterRequest | null | undefined, {} | null | undefined>): void;
Parameters
Name Description
request IGetOrchestrationClusterRequest
options CallOptions
callback Callback<protos.google.cloud.telcoautomation.v1alpha1.IOrchestrationCluster, protos.google.cloud.telcoautomation.v1alpha1.IGetOrchestrationClusterRequest | null | undefined, {} | null | undefined>
Returns
Type Description
void

getOrchestrationCluster(request, callback)

getOrchestrationCluster(request: protos.google.cloud.telcoautomation.v1alpha1.IGetOrchestrationClusterRequest, callback: Callback<protos.google.cloud.telcoautomation.v1alpha1.IOrchestrationCluster, protos.google.cloud.telcoautomation.v1alpha1.IGetOrchestrationClusterRequest | null | undefined, {} | null | undefined>): void;
Parameters
Name Description
request IGetOrchestrationClusterRequest
callback Callback<protos.google.cloud.telcoautomation.v1alpha1.IOrchestrationCluster, protos.google.cloud.telcoautomation.v1alpha1.IGetOrchestrationClusterRequest | null | undefined, {} | null | undefined>
Returns
Type Description
void

getProjectId()

getProjectId(): Promise<string>;
Returns
Type Description
Promise<string>

getProjectId(callback)

getProjectId(callback: Callback<string, undefined, undefined>): void;
Parameter
Name Description
callback Callback<string, undefined, undefined>
Returns
Type Description
void

getPublicBlueprint(request, options)

getPublicBlueprint(request?: protos.google.cloud.telcoautomation.v1alpha1.IGetPublicBlueprintRequest, options?: CallOptions): Promise<[
        protos.google.cloud.telcoautomation.v1alpha1.IPublicBlueprint,
        (protos.google.cloud.telcoautomation.v1alpha1.IGetPublicBlueprintRequest | undefined),
        {} | undefined
    ]>;

Returns the requested public blueprint.

Parameters
Name Description
request IGetPublicBlueprintRequest

The request object that will be sent.

options CallOptions

Call options. See CallOptions for more details.

Returns
Type Description
Promise<[ protos.google.cloud.telcoautomation.v1alpha1.IPublicBlueprint, (protos.google.cloud.telcoautomation.v1alpha1.IGetPublicBlueprintRequest | undefined), {} | undefined ]>

{Promise} - The promise which resolves to an array. The first element of the array is an object representing PublicBlueprint. 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 public blueprint.
   */
  // const name = 'abc123'

  // Imports the Telcoautomation library
  const {TelcoAutomationClient} = require('@google-cloud/telcoautomation').v1alpha1;

  // Instantiates a client
  const telcoautomationClient = new TelcoAutomationClient();

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

    // Run request
    const response = await telcoautomationClient.getPublicBlueprint(request);
    console.log(response);
  }

  callGetPublicBlueprint();

getPublicBlueprint(request, options, callback)

getPublicBlueprint(request: protos.google.cloud.telcoautomation.v1alpha1.IGetPublicBlueprintRequest, options: CallOptions, callback: Callback<protos.google.cloud.telcoautomation.v1alpha1.IPublicBlueprint, protos.google.cloud.telcoautomation.v1alpha1.IGetPublicBlueprintRequest | null | undefined, {} | null | undefined>): void;
Parameters
Name Description
request IGetPublicBlueprintRequest
options CallOptions
callback Callback<protos.google.cloud.telcoautomation.v1alpha1.IPublicBlueprint, protos.google.cloud.telcoautomation.v1alpha1.IGetPublicBlueprintRequest | null | undefined, {} | null | undefined>
Returns
Type Description
void

getPublicBlueprint(request, callback)

getPublicBlueprint(request: protos.google.cloud.telcoautomation.v1alpha1.IGetPublicBlueprintRequest, callback: Callback<protos.google.cloud.telcoautomation.v1alpha1.IPublicBlueprint, protos.google.cloud.telcoautomation.v1alpha1.IGetPublicBlueprintRequest | null | undefined, {} | null | undefined>): void;
Parameters
Name Description
request IGetPublicBlueprintRequest
callback Callback<protos.google.cloud.telcoautomation.v1alpha1.IPublicBlueprint, protos.google.cloud.telcoautomation.v1alpha1.IGetPublicBlueprintRequest | null | undefined, {} | null | undefined>
Returns
Type Description
void

hydratedDeploymentPath(project, location, orchestrationCluster, deployment, hydratedDeployment)

hydratedDeploymentPath(project: string, location: string, orchestrationCluster: string, deployment: string, hydratedDeployment: string): string;

Return a fully-qualified hydratedDeployment resource name string.

Parameters
Name Description
project string
location string
orchestrationCluster string
deployment string
hydratedDeployment string
Returns
Type Description
string

{string} Resource name string.

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.

listBlueprintRevisions(request, options)

listBlueprintRevisions(request?: protos.google.cloud.telcoautomation.v1alpha1.IListBlueprintRevisionsRequest, options?: CallOptions): Promise<[
        protos.google.cloud.telcoautomation.v1alpha1.IBlueprint[],
        protos.google.cloud.telcoautomation.v1alpha1.IListBlueprintRevisionsRequest | null,
        protos.google.cloud.telcoautomation.v1alpha1.IListBlueprintRevisionsResponse
    ]>;

List blueprint revisions of a given blueprint.

Parameters
Name Description
request IListBlueprintRevisionsRequest

The request object that will be sent.

options CallOptions

Call options. See CallOptions for more details.

Returns
Type Description
Promise<[ protos.google.cloud.telcoautomation.v1alpha1.IBlueprint[], protos.google.cloud.telcoautomation.v1alpha1.IListBlueprintRevisionsRequest | null, protos.google.cloud.telcoautomation.v1alpha1.IListBlueprintRevisionsResponse ]>

{Promise} - The promise which resolves to an array. The first element of the array is Array of . The client library will perform auto-pagination by default: it will call the API as many times as needed and will merge results from all the pages into this array. Note that it can affect your quota. We recommend using listBlueprintRevisionsAsync() method described below for async iteration which you can stop as needed. Please see the documentation for more details and examples.

listBlueprintRevisions(request, options, callback)

listBlueprintRevisions(request: protos.google.cloud.telcoautomation.v1alpha1.IListBlueprintRevisionsRequest, options: CallOptions, callback: PaginationCallback<protos.google.cloud.telcoautomation.v1alpha1.IListBlueprintRevisionsRequest, protos.google.cloud.telcoautomation.v1alpha1.IListBlueprintRevisionsResponse | null | undefined, protos.google.cloud.telcoautomation.v1alpha1.IBlueprint>): void;
Parameters
Name Description
request IListBlueprintRevisionsRequest
options CallOptions
callback PaginationCallback<protos.google.cloud.telcoautomation.v1alpha1.IListBlueprintRevisionsRequest, protos.google.cloud.telcoautomation.v1alpha1.IListBlueprintRevisionsResponse | null | undefined, protos.google.cloud.telcoautomation.v1alpha1.IBlueprint>
Returns
Type Description
void

listBlueprintRevisions(request, callback)

listBlueprintRevisions(request: protos.google.cloud.telcoautomation.v1alpha1.IListBlueprintRevisionsRequest, callback: PaginationCallback<protos.google.cloud.telcoautomation.v1alpha1.IListBlueprintRevisionsRequest, protos.google.cloud.telcoautomation.v1alpha1.IListBlueprintRevisionsResponse | null | undefined, protos.google.cloud.telcoautomation.v1alpha1.IBlueprint>): void;
Parameters
Name Description
request IListBlueprintRevisionsRequest
callback PaginationCallback<protos.google.cloud.telcoautomation.v1alpha1.IListBlueprintRevisionsRequest, protos.google.cloud.telcoautomation.v1alpha1.IListBlueprintRevisionsResponse | null | undefined, protos.google.cloud.telcoautomation.v1alpha1.IBlueprint>
Returns
Type Description
void

listBlueprintRevisionsAsync(request, options)

listBlueprintRevisionsAsync(request?: protos.google.cloud.telcoautomation.v1alpha1.IListBlueprintRevisionsRequest, options?: CallOptions): AsyncIterable<protos.google.cloud.telcoautomation.v1alpha1.IBlueprint>;

Equivalent to listBlueprintRevisions, but returns an iterable object.

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

Parameters
Name Description
request IListBlueprintRevisionsRequest

The request object that will be sent.

options CallOptions

Call options. See CallOptions for more details.

Returns
Type Description
AsyncIterable<protos.google.cloud.telcoautomation.v1alpha1.IBlueprint>

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

Example

  /**
   * This snippet has been automatically generated and should be regarded as a code template only.
   * It will require modifications to work.
   * It may require correct/in-range values for request initialization.
   * TODO(developer): Uncomment these variables before running the sample.
   */
  /**
   *  Required. The name of the blueprint to list revisions for.
   */
  // const name = 'abc123'
  /**
   *  The maximum number of revisions to return per page.
   */
  // const pageSize = 1234
  /**
   *  The page token, received from a previous ListBlueprintRevisions call
   *  It can be provided to retrieve the subsequent page.
   */
  // const pageToken = 'abc123'

  // Imports the Telcoautomation library
  const {TelcoAutomationClient} = require('@google-cloud/telcoautomation').v1alpha1;

  // Instantiates a client
  const telcoautomationClient = new TelcoAutomationClient();

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

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

  callListBlueprintRevisions();

listBlueprintRevisionsStream(request, options)

listBlueprintRevisionsStream(request?: protos.google.cloud.telcoautomation.v1alpha1.IListBlueprintRevisionsRequest, options?: CallOptions): Transform;

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

Parameters
Name Description
request IListBlueprintRevisionsRequest

The request object that will be sent.

options CallOptions

Call options. See CallOptions for more details.

Returns
Type Description
Transform

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

listBlueprints(request, options)

listBlueprints(request?: protos.google.cloud.telcoautomation.v1alpha1.IListBlueprintsRequest, options?: CallOptions): Promise<[
        protos.google.cloud.telcoautomation.v1alpha1.IBlueprint[],
        protos.google.cloud.telcoautomation.v1alpha1.IListBlueprintsRequest | null,
        protos.google.cloud.telcoautomation.v1alpha1.IListBlueprintsResponse
    ]>;

List all blueprints.

Parameters
Name Description
request IListBlueprintsRequest

The request object that will be sent.

options CallOptions

Call options. See CallOptions for more details.

Returns
Type Description
Promise<[ protos.google.cloud.telcoautomation.v1alpha1.IBlueprint[], protos.google.cloud.telcoautomation.v1alpha1.IListBlueprintsRequest | null, protos.google.cloud.telcoautomation.v1alpha1.IListBlueprintsResponse ]>

{Promise} - The promise which resolves to an array. The first element of the array is Array of . The client library will perform auto-pagination by default: it will call the API as many times as needed and will merge results from all the pages into this array. Note that it can affect your quota. We recommend using listBlueprintsAsync() method described below for async iteration which you can stop as needed. Please see the documentation for more details and examples.

listBlueprints(request, options, callback)

listBlueprints(request: protos.google.cloud.telcoautomation.v1alpha1.IListBlueprintsRequest, options: CallOptions, callback: PaginationCallback<protos.google.cloud.telcoautomation.v1alpha1.IListBlueprintsRequest, protos.google.cloud.telcoautomation.v1alpha1.IListBlueprintsResponse | null | undefined, protos.google.cloud.telcoautomation.v1alpha1.IBlueprint>): void;
Parameters
Name Description
request IListBlueprintsRequest
options CallOptions
callback PaginationCallback<protos.google.cloud.telcoautomation.v1alpha1.IListBlueprintsRequest, protos.google.cloud.telcoautomation.v1alpha1.IListBlueprintsResponse | null | undefined, protos.google.cloud.telcoautomation.v1alpha1.IBlueprint>
Returns
Type Description
void

listBlueprints(request, callback)

listBlueprints(request: protos.google.cloud.telcoautomation.v1alpha1.IListBlueprintsRequest, callback: PaginationCallback<protos.google.cloud.telcoautomation.v1alpha1.IListBlueprintsRequest, protos.google.cloud.telcoautomation.v1alpha1.IListBlueprintsResponse | null | undefined, protos.google.cloud.telcoautomation.v1alpha1.IBlueprint>): void;
Parameters
Name Description
request IListBlueprintsRequest
callback PaginationCallback<protos.google.cloud.telcoautomation.v1alpha1.IListBlueprintsRequest, protos.google.cloud.telcoautomation.v1alpha1.IListBlueprintsResponse | null | undefined, protos.google.cloud.telcoautomation.v1alpha1.IBlueprint>
Returns
Type Description
void

listBlueprintsAsync(request, options)

listBlueprintsAsync(request?: protos.google.cloud.telcoautomation.v1alpha1.IListBlueprintsRequest, options?: CallOptions): AsyncIterable<protos.google.cloud.telcoautomation.v1alpha1.IBlueprint>;

Equivalent to listBlueprints, but returns an iterable object.

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

Parameters
Name Description
request IListBlueprintsRequest

The request object that will be sent.

options CallOptions

Call options. See CallOptions for more details.

Returns
Type Description
AsyncIterable<protos.google.cloud.telcoautomation.v1alpha1.IBlueprint>

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

Example

  /**
   * This snippet has been automatically generated and should be regarded as a code template only.
   * It will require modifications to work.
   * It may require correct/in-range values for request initialization.
   * TODO(developer): Uncomment these variables before running the sample.
   */
  /**
   *  Required. The name of parent orchestration cluster resource.
   *  Format should be -
   *  "projects/{project_id}/locations/{location_name}/orchestrationClusters/{orchestration_cluster}".
   */
  // const parent = 'abc123'
  /**
   *  Optional. Filtering only supports equality on blueprint state.
   *  It should be in the form: "state = DRAFT". `OR` operator can be used to
   *  get response for multiple states. e.g. "state = DRAFT OR state = PROPOSED".
   */
  // const filter = 'abc123'
  /**
   *  Optional. The maximum number of blueprints to return per page.
   */
  // const pageSize = 1234
  /**
   *  Optional. The page token, received from a previous ListBlueprints call.
   *  It can be provided to retrieve the subsequent page.
   */
  // const pageToken = 'abc123'

  // Imports the Telcoautomation library
  const {TelcoAutomationClient} = require('@google-cloud/telcoautomation').v1alpha1;

  // Instantiates a client
  const telcoautomationClient = new TelcoAutomationClient();

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

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

  callListBlueprints();

listBlueprintsStream(request, options)

listBlueprintsStream(request?: protos.google.cloud.telcoautomation.v1alpha1.IListBlueprintsRequest, options?: CallOptions): Transform;

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

Parameters
Name Description
request IListBlueprintsRequest

The request object that will be sent.

options CallOptions

Call options. See CallOptions for more details.

Returns
Type Description
Transform

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

listDeploymentRevisions(request, options)

listDeploymentRevisions(request?: protos.google.cloud.telcoautomation.v1alpha1.IListDeploymentRevisionsRequest, options?: CallOptions): Promise<[
        protos.google.cloud.telcoautomation.v1alpha1.IDeployment[],
        protos.google.cloud.telcoautomation.v1alpha1.IListDeploymentRevisionsRequest | null,
        protos.google.cloud.telcoautomation.v1alpha1.IListDeploymentRevisionsResponse
    ]>;

List deployment revisions of a given deployment.

Parameters
Name Description
request IListDeploymentRevisionsRequest

The request object that will be sent.

options CallOptions

Call options. See CallOptions for more details.

Returns
Type Description
Promise<[ protos.google.cloud.telcoautomation.v1alpha1.IDeployment[], protos.google.cloud.telcoautomation.v1alpha1.IListDeploymentRevisionsRequest | null, protos.google.cloud.telcoautomation.v1alpha1.IListDeploymentRevisionsResponse ]>

{Promise} - The promise which resolves to an array. The first element of the array is Array of . The client library will perform auto-pagination by default: it will call the API as many times as needed and will merge results from all the pages into this array. Note that it can affect your quota. We recommend using listDeploymentRevisionsAsync() method described below for async iteration which you can stop as needed. Please see the documentation for more details and examples.

listDeploymentRevisions(request, options, callback)

listDeploymentRevisions(request: protos.google.cloud.telcoautomation.v1alpha1.IListDeploymentRevisionsRequest, options: CallOptions, callback: PaginationCallback<protos.google.cloud.telcoautomation.v1alpha1.IListDeploymentRevisionsRequest, protos.google.cloud.telcoautomation.v1alpha1.IListDeploymentRevisionsResponse | null | undefined, protos.google.cloud.telcoautomation.v1alpha1.IDeployment>): void;
Parameters
Name Description
request IListDeploymentRevisionsRequest
options CallOptions
callback PaginationCallback<protos.google.cloud.telcoautomation.v1alpha1.IListDeploymentRevisionsRequest, protos.google.cloud.telcoautomation.v1alpha1.IListDeploymentRevisionsResponse | null | undefined, protos.google.cloud.telcoautomation.v1alpha1.IDeployment>
Returns
Type Description
void

listDeploymentRevisions(request, callback)

listDeploymentRevisions(request: protos.google.cloud.telcoautomation.v1alpha1.IListDeploymentRevisionsRequest, callback: PaginationCallback<protos.google.cloud.telcoautomation.v1alpha1.IListDeploymentRevisionsRequest, protos.google.cloud.telcoautomation.v1alpha1.IListDeploymentRevisionsResponse | null | undefined, protos.google.cloud.telcoautomation.v1alpha1.IDeployment>): void;
Parameters
Name Description
request IListDeploymentRevisionsRequest
callback PaginationCallback<protos.google.cloud.telcoautomation.v1alpha1.IListDeploymentRevisionsRequest, protos.google.cloud.telcoautomation.v1alpha1.IListDeploymentRevisionsResponse | null | undefined, protos.google.cloud.telcoautomation.v1alpha1.IDeployment>
Returns
Type Description
void

listDeploymentRevisionsAsync(request, options)

listDeploymentRevisionsAsync(request?: protos.google.cloud.telcoautomation.v1alpha1.IListDeploymentRevisionsRequest, options?: CallOptions): AsyncIterable<protos.google.cloud.telcoautomation.v1alpha1.IDeployment>;

Equivalent to listDeploymentRevisions, but returns an iterable object.

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

Parameters
Name Description
request IListDeploymentRevisionsRequest

The request object that will be sent.

options CallOptions

Call options. See CallOptions for more details.

Returns
Type Description
AsyncIterable<protos.google.cloud.telcoautomation.v1alpha1.IDeployment>

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

Example

  /**
   * This snippet has been automatically generated and should be regarded as a code template only.
   * It will require modifications to work.
   * It may require correct/in-range values for request initialization.
   * TODO(developer): Uncomment these variables before running the sample.
   */
  /**
   *  Required. The name of the deployment to list revisions for.
   */
  // const name = 'abc123'
  /**
   *  Optional. The maximum number of revisions to return per page.
   */
  // const pageSize = 1234
  /**
   *  Optional. The page token, received from a previous ListDeploymentRevisions
   *  call Provide this to retrieve the subsequent page.
   */
  // const pageToken = 'abc123'

  // Imports the Telcoautomation library
  const {TelcoAutomationClient} = require('@google-cloud/telcoautomation').v1alpha1;

  // Instantiates a client
  const telcoautomationClient = new TelcoAutomationClient();

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

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

  callListDeploymentRevisions();

listDeploymentRevisionsStream(request, options)

listDeploymentRevisionsStream(request?: protos.google.cloud.telcoautomation.v1alpha1.IListDeploymentRevisionsRequest, options?: CallOptions): Transform;

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

Parameters
Name Description
request IListDeploymentRevisionsRequest

The request object that will be sent.

options CallOptions

Call options. See CallOptions for more details.

Returns
Type Description
Transform

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

listDeployments(request, options)

listDeployments(request?: protos.google.cloud.telcoautomation.v1alpha1.IListDeploymentsRequest, options?: CallOptions): Promise<[
        protos.google.cloud.telcoautomation.v1alpha1.IDeployment[],
        protos.google.cloud.telcoautomation.v1alpha1.IListDeploymentsRequest | null,
        protos.google.cloud.telcoautomation.v1alpha1.IListDeploymentsResponse
    ]>;

List all deployments.

Parameters
Name Description
request IListDeploymentsRequest

The request object that will be sent.

options CallOptions

Call options. See CallOptions for more details.

Returns
Type Description
Promise<[ protos.google.cloud.telcoautomation.v1alpha1.IDeployment[], protos.google.cloud.telcoautomation.v1alpha1.IListDeploymentsRequest | null, protos.google.cloud.telcoautomation.v1alpha1.IListDeploymentsResponse ]>

{Promise} - The promise which resolves to an array. The first element of the array is Array of . The client library will perform auto-pagination by default: it will call the API as many times as needed and will merge results from all the pages into this array. Note that it can affect your quota. We recommend using listDeploymentsAsync() method described below for async iteration which you can stop as needed. Please see the documentation for more details and examples.

listDeployments(request, options, callback)

listDeployments(request: protos.google.cloud.telcoautomation.v1alpha1.IListDeploymentsRequest, options: CallOptions, callback: PaginationCallback<protos.google.cloud.telcoautomation.v1alpha1.IListDeploymentsRequest, protos.google.cloud.telcoautomation.v1alpha1.IListDeploymentsResponse | null | undefined, protos.google.cloud.telcoautomation.v1alpha1.IDeployment>): void;
Parameters
Name Description
request IListDeploymentsRequest
options CallOptions
callback PaginationCallback<protos.google.cloud.telcoautomation.v1alpha1.IListDeploymentsRequest, protos.google.cloud.telcoautomation.v1alpha1.IListDeploymentsResponse | null | undefined, protos.google.cloud.telcoautomation.v1alpha1.IDeployment>
Returns
Type Description
void

listDeployments(request, callback)

listDeployments(request: protos.google.cloud.telcoautomation.v1alpha1.IListDeploymentsRequest, callback: PaginationCallback<protos.google.cloud.telcoautomation.v1alpha1.IListDeploymentsRequest, protos.google.cloud.telcoautomation.v1alpha1.IListDeploymentsResponse | null | undefined, protos.google.cloud.telcoautomation.v1alpha1.IDeployment>): void;
Parameters
Name Description
request IListDeploymentsRequest
callback PaginationCallback<protos.google.cloud.telcoautomation.v1alpha1.IListDeploymentsRequest, protos.google.cloud.telcoautomation.v1alpha1.IListDeploymentsResponse | null | undefined, protos.google.cloud.telcoautomation.v1alpha1.IDeployment>
Returns
Type Description
void

listDeploymentsAsync(request, options)

listDeploymentsAsync(request?: protos.google.cloud.telcoautomation.v1alpha1.IListDeploymentsRequest, options?: CallOptions): AsyncIterable<protos.google.cloud.telcoautomation.v1alpha1.IDeployment>;

Equivalent to listDeployments, but returns an iterable object.

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

Parameters
Name Description
request IListDeploymentsRequest

The request object that will be sent.

options CallOptions

Call options. See CallOptions for more details.

Returns
Type Description
AsyncIterable<protos.google.cloud.telcoautomation.v1alpha1.IDeployment>

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

Example

  /**
   * This snippet has been automatically generated and should be regarded as a code template only.
   * It will require modifications to work.
   * It may require correct/in-range values for request initialization.
   * TODO(developer): Uncomment these variables before running the sample.
   */
  /**
   *  Required. The name of parent orchestration cluster resource.
   *  Format should be -
   *  "projects/{project_id}/locations/{location_name}/orchestrationClusters/{orchestration_cluster}".
   */
  // const parent = 'abc123'
  /**
   *  Optional. Filtering only supports equality on deployment state.
   *  It should be in the form: "state = DRAFT". `OR` operator can be used to
   *  get response for multiple states. e.g. "state = DRAFT OR state = APPLIED".
   */
  // const filter = 'abc123'
  /**
   *  Optional. The maximum number of deployments to return per page.
   */
  // const pageSize = 1234
  /**
   *  Optional. The page token, received from a previous ListDeployments call.
   *  It can be provided to retrieve the subsequent page.
   */
  // const pageToken = 'abc123'

  // Imports the Telcoautomation library
  const {TelcoAutomationClient} = require('@google-cloud/telcoautomation').v1alpha1;

  // Instantiates a client
  const telcoautomationClient = new TelcoAutomationClient();

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

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

  callListDeployments();

listDeploymentsStream(request, options)

listDeploymentsStream(request?: protos.google.cloud.telcoautomation.v1alpha1.IListDeploymentsRequest, options?: CallOptions): Transform;

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

Parameters
Name Description
request IListDeploymentsRequest

The request object that will be sent.

options CallOptions

Call options. See CallOptions for more details.

Returns
Type Description
Transform

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

listEdgeSlms(request, options)

listEdgeSlms(request?: protos.google.cloud.telcoautomation.v1alpha1.IListEdgeSlmsRequest, options?: CallOptions): Promise<[
        protos.google.cloud.telcoautomation.v1alpha1.IEdgeSlm[],
        protos.google.cloud.telcoautomation.v1alpha1.IListEdgeSlmsRequest | null,
        protos.google.cloud.telcoautomation.v1alpha1.IListEdgeSlmsResponse
    ]>;

Lists EdgeSlms in a given project and location.

Parameters
Name Description
request IListEdgeSlmsRequest

The request object that will be sent.

options CallOptions

Call options. See CallOptions for more details.

Returns
Type Description
Promise<[ protos.google.cloud.telcoautomation.v1alpha1.IEdgeSlm[], protos.google.cloud.telcoautomation.v1alpha1.IListEdgeSlmsRequest | null, protos.google.cloud.telcoautomation.v1alpha1.IListEdgeSlmsResponse ]>

{Promise} - The promise which resolves to an array. The first element of the array is Array of . The client library will perform auto-pagination by default: it will call the API as many times as needed and will merge results from all the pages into this array. Note that it can affect your quota. We recommend using listEdgeSlmsAsync() method described below for async iteration which you can stop as needed. Please see the documentation for more details and examples.

listEdgeSlms(request, options, callback)

listEdgeSlms(request: protos.google.cloud.telcoautomation.v1alpha1.IListEdgeSlmsRequest, options: CallOptions, callback: PaginationCallback<protos.google.cloud.telcoautomation.v1alpha1.IListEdgeSlmsRequest, protos.google.cloud.telcoautomation.v1alpha1.IListEdgeSlmsResponse | null | undefined, protos.google.cloud.telcoautomation.v1alpha1.IEdgeSlm>): void;
Parameters
Name Description
request IListEdgeSlmsRequest
options CallOptions
callback PaginationCallback<protos.google.cloud.telcoautomation.v1alpha1.IListEdgeSlmsRequest, protos.google.cloud.telcoautomation.v1alpha1.IListEdgeSlmsResponse | null | undefined, protos.google.cloud.telcoautomation.v1alpha1.IEdgeSlm>
Returns
Type Description
void

listEdgeSlms(request, callback)

listEdgeSlms(request: protos.google.cloud.telcoautomation.v1alpha1.IListEdgeSlmsRequest, callback: PaginationCallback<protos.google.cloud.telcoautomation.v1alpha1.IListEdgeSlmsRequest, protos.google.cloud.telcoautomation.v1alpha1.IListEdgeSlmsResponse | null | undefined, protos.google.cloud.telcoautomation.v1alpha1.IEdgeSlm>): void;
Parameters
Name Description
request IListEdgeSlmsRequest
callback PaginationCallback<protos.google.cloud.telcoautomation.v1alpha1.IListEdgeSlmsRequest, protos.google.cloud.telcoautomation.v1alpha1.IListEdgeSlmsResponse | null | undefined, protos.google.cloud.telcoautomation.v1alpha1.IEdgeSlm>
Returns
Type Description
void

listEdgeSlmsAsync(request, options)

listEdgeSlmsAsync(request?: protos.google.cloud.telcoautomation.v1alpha1.IListEdgeSlmsRequest, options?: CallOptions): AsyncIterable<protos.google.cloud.telcoautomation.v1alpha1.IEdgeSlm>;

Equivalent to listEdgeSlms, but returns an iterable object.

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

Parameters
Name Description
request IListEdgeSlmsRequest

The request object that will be sent.

options CallOptions

Call options. See CallOptions for more details.

Returns
Type Description
AsyncIterable<protos.google.cloud.telcoautomation.v1alpha1.IEdgeSlm>

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

Example

  /**
   * This snippet has been automatically generated and should be regarded as a code template only.
   * It will require modifications to work.
   * It may require correct/in-range values for request initialization.
   * TODO(developer): Uncomment these variables before running the sample.
   */
  /**
   *  Required. Parent value for ListEdgeSlmsRequest
   */
  // 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 Telcoautomation library
  const {TelcoAutomationClient} = require('@google-cloud/telcoautomation').v1alpha1;

  // Instantiates a client
  const telcoautomationClient = new TelcoAutomationClient();

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

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

  callListEdgeSlms();

listEdgeSlmsStream(request, options)

listEdgeSlmsStream(request?: protos.google.cloud.telcoautomation.v1alpha1.IListEdgeSlmsRequest, options?: CallOptions): Transform;

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

Parameters
Name Description
request IListEdgeSlmsRequest

The request object that will be sent.

options CallOptions

Call options. See CallOptions for more details.

Returns
Type Description
Transform

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

listHydratedDeployments(request, options)

listHydratedDeployments(request?: protos.google.cloud.telcoautomation.v1alpha1.IListHydratedDeploymentsRequest, options?: CallOptions): Promise<[
        protos.google.cloud.telcoautomation.v1alpha1.IHydratedDeployment[],
        protos.google.cloud.telcoautomation.v1alpha1.IListHydratedDeploymentsRequest | null,
        protos.google.cloud.telcoautomation.v1alpha1.IListHydratedDeploymentsResponse
    ]>;

List all hydrated deployments present under a deployment.

Parameters
Name Description
request IListHydratedDeploymentsRequest

The request object that will be sent.

options CallOptions

Call options. See CallOptions for more details.

Returns
Type Description
Promise<[ protos.google.cloud.telcoautomation.v1alpha1.IHydratedDeployment[], protos.google.cloud.telcoautomation.v1alpha1.IListHydratedDeploymentsRequest | null, protos.google.cloud.telcoautomation.v1alpha1.IListHydratedDeploymentsResponse ]>

{Promise} - The promise which resolves to an array. The first element of the array is Array of . The client library will perform auto-pagination by default: it will call the API as many times as needed and will merge results from all the pages into this array. Note that it can affect your quota. We recommend using listHydratedDeploymentsAsync() method described below for async iteration which you can stop as needed. Please see the documentation for more details and examples.

listHydratedDeployments(request, options, callback)

listHydratedDeployments(request: protos.google.cloud.telcoautomation.v1alpha1.IListHydratedDeploymentsRequest, options: CallOptions, callback: PaginationCallback<protos.google.cloud.telcoautomation.v1alpha1.IListHydratedDeploymentsRequest, protos.google.cloud.telcoautomation.v1alpha1.IListHydratedDeploymentsResponse | null | undefined, protos.google.cloud.telcoautomation.v1alpha1.IHydratedDeployment>): void;
Parameters
Name Description
request IListHydratedDeploymentsRequest
options CallOptions
callback PaginationCallback<protos.google.cloud.telcoautomation.v1alpha1.IListHydratedDeploymentsRequest, protos.google.cloud.telcoautomation.v1alpha1.IListHydratedDeploymentsResponse | null | undefined, protos.google.cloud.telcoautomation.v1alpha1.IHydratedDeployment>
Returns
Type Description
void

listHydratedDeployments(request, callback)

listHydratedDeployments(request: protos.google.cloud.telcoautomation.v1alpha1.IListHydratedDeploymentsRequest, callback: PaginationCallback<protos.google.cloud.telcoautomation.v1alpha1.IListHydratedDeploymentsRequest, protos.google.cloud.telcoautomation.v1alpha1.IListHydratedDeploymentsResponse | null | undefined, protos.google.cloud.telcoautomation.v1alpha1.IHydratedDeployment>): void;
Parameters
Name Description
request IListHydratedDeploymentsRequest
callback PaginationCallback<protos.google.cloud.telcoautomation.v1alpha1.IListHydratedDeploymentsRequest, protos.google.cloud.telcoautomation.v1alpha1.IListHydratedDeploymentsResponse | null | undefined, protos.google.cloud.telcoautomation.v1alpha1.IHydratedDeployment>
Returns
Type Description
void

listHydratedDeploymentsAsync(request, options)

listHydratedDeploymentsAsync(request?: protos.google.cloud.telcoautomation.v1alpha1.IListHydratedDeploymentsRequest, options?: CallOptions): AsyncIterable<protos.google.cloud.telcoautomation.v1alpha1.IHydratedDeployment>;

Equivalent to listHydratedDeployments, but returns an iterable object.

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

Parameters
Name Description
request IListHydratedDeploymentsRequest

The request object that will be sent.

options CallOptions

Call options. See CallOptions for more details.

Returns
Type Description
AsyncIterable<protos.google.cloud.telcoautomation.v1alpha1.IHydratedDeployment>

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

Example

  /**
   * This snippet has been automatically generated and should be regarded as a code template only.
   * It will require modifications to work.
   * It may require correct/in-range values for request initialization.
   * TODO(developer): Uncomment these variables before running the sample.
   */
  /**
   *  Required. The deployment managing the hydrated deployments.
   */
  // const parent = 'abc123'
  /**
   *  Optional. The maximum number of hydrated deployments to return. The service
   *  may return fewer than this value. If unspecified, at most 50 hydrated
   *  deployments will be returned. The maximum value is 1000. Values above 1000
   *  will be set to 1000.
   */
  // const pageSize = 1234
  /**
   *  Optional. The page token, received from a previous ListHydratedDeployments
   *  call. Provide this to retrieve the subsequent page.
   */
  // const pageToken = 'abc123'

  // Imports the Telcoautomation library
  const {TelcoAutomationClient} = require('@google-cloud/telcoautomation').v1alpha1;

  // Instantiates a client
  const telcoautomationClient = new TelcoAutomationClient();

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

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

  callListHydratedDeployments();

listHydratedDeploymentsStream(request, options)

listHydratedDeploymentsStream(request?: protos.google.cloud.telcoautomation.v1alpha1.IListHydratedDeploymentsRequest, options?: CallOptions): Transform;

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

Parameters
Name Description
request IListHydratedDeploymentsRequest

The request object that will be sent.

options CallOptions

Call options. See CallOptions for more details.

Returns
Type Description
Transform

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

listLocationsAsync(request, options)

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

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

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

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

The request object that will be sent.

options CallOptions

Call options. See CallOptions for more details.

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

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

Example

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

listOperationsAsync(request, options)

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

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.ListOperationsResponse>

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

Example

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

listOrchestrationClusters(request, options)

listOrchestrationClusters(request?: protos.google.cloud.telcoautomation.v1alpha1.IListOrchestrationClustersRequest, options?: CallOptions): Promise<[
        protos.google.cloud.telcoautomation.v1alpha1.IOrchestrationCluster[],
        protos.google.cloud.telcoautomation.v1alpha1.IListOrchestrationClustersRequest | null,
        protos.google.cloud.telcoautomation.v1alpha1.IListOrchestrationClustersResponse
    ]>;

Lists OrchestrationClusters in a given project and location.

Parameters
Name Description
request IListOrchestrationClustersRequest

The request object that will be sent.

options CallOptions

Call options. See CallOptions for more details.

Returns
Type Description
Promise<[ protos.google.cloud.telcoautomation.v1alpha1.IOrchestrationCluster[], protos.google.cloud.telcoautomation.v1alpha1.IListOrchestrationClustersRequest | null, protos.google.cloud.telcoautomation.v1alpha1.IListOrchestrationClustersResponse ]>

{Promise} - The promise which resolves to an array. The first element of the array is Array of . The client library will perform auto-pagination by default: it will call the API as many times as needed and will merge results from all the pages into this array. Note that it can affect your quota. We recommend using listOrchestrationClustersAsync() method described below for async iteration which you can stop as needed. Please see the documentation for more details and examples.

listOrchestrationClusters(request, options, callback)

listOrchestrationClusters(request: protos.google.cloud.telcoautomation.v1alpha1.IListOrchestrationClustersRequest, options: CallOptions, callback: PaginationCallback<protos.google.cloud.telcoautomation.v1alpha1.IListOrchestrationClustersRequest, protos.google.cloud.telcoautomation.v1alpha1.IListOrchestrationClustersResponse | null | undefined, protos.google.cloud.telcoautomation.v1alpha1.IOrchestrationCluster>): void;
Parameters
Name Description
request IListOrchestrationClustersRequest
options CallOptions
callback PaginationCallback<protos.google.cloud.telcoautomation.v1alpha1.IListOrchestrationClustersRequest, protos.google.cloud.telcoautomation.v1alpha1.IListOrchestrationClustersResponse | null | undefined, protos.google.cloud.telcoautomation.v1alpha1.IOrchestrationCluster>
Returns
Type Description
void

listOrchestrationClusters(request, callback)

listOrchestrationClusters(request: protos.google.cloud.telcoautomation.v1alpha1.IListOrchestrationClustersRequest, callback: PaginationCallback<protos.google.cloud.telcoautomation.v1alpha1.IListOrchestrationClustersRequest, protos.google.cloud.telcoautomation.v1alpha1.IListOrchestrationClustersResponse | null | undefined, protos.google.cloud.telcoautomation.v1alpha1.IOrchestrationCluster>): void;
Parameters
Name Description
request IListOrchestrationClustersRequest
callback PaginationCallback<protos.google.cloud.telcoautomation.v1alpha1.IListOrchestrationClustersRequest, protos.google.cloud.telcoautomation.v1alpha1.IListOrchestrationClustersResponse | null | undefined, protos.google.cloud.telcoautomation.v1alpha1.IOrchestrationCluster>
Returns
Type Description
void

listOrchestrationClustersAsync(request, options)

listOrchestrationClustersAsync(request?: protos.google.cloud.telcoautomation.v1alpha1.IListOrchestrationClustersRequest, options?: CallOptions): AsyncIterable<protos.google.cloud.telcoautomation.v1alpha1.IOrchestrationCluster>;

Equivalent to listOrchestrationClusters, but returns an iterable object.

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

Parameters
Name Description
request IListOrchestrationClustersRequest

The request object that will be sent.

options CallOptions

Call options. See CallOptions for more details.

Returns
Type Description
AsyncIterable<protos.google.cloud.telcoautomation.v1alpha1.IOrchestrationCluster>

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

Example

  /**
   * This snippet has been automatically generated and should be regarded as a code template only.
   * It will require modifications to work.
   * It may require correct/in-range values for request initialization.
   * TODO(developer): Uncomment these variables before running the sample.
   */
  /**
   *  Required. Parent value for ListOrchestrationClustersRequest
   */
  // 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 Telcoautomation library
  const {TelcoAutomationClient} = require('@google-cloud/telcoautomation').v1alpha1;

  // Instantiates a client
  const telcoautomationClient = new TelcoAutomationClient();

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

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

  callListOrchestrationClusters();

listOrchestrationClustersStream(request, options)

listOrchestrationClustersStream(request?: protos.google.cloud.telcoautomation.v1alpha1.IListOrchestrationClustersRequest, options?: CallOptions): Transform;

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

Parameters
Name Description
request IListOrchestrationClustersRequest

The request object that will be sent.

options CallOptions

Call options. See CallOptions for more details.

Returns
Type Description
Transform

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

listPublicBlueprints(request, options)

listPublicBlueprints(request?: protos.google.cloud.telcoautomation.v1alpha1.IListPublicBlueprintsRequest, options?: CallOptions): Promise<[
        protos.google.cloud.telcoautomation.v1alpha1.IPublicBlueprint[],
        protos.google.cloud.telcoautomation.v1alpha1.IListPublicBlueprintsRequest | null,
        protos.google.cloud.telcoautomation.v1alpha1.IListPublicBlueprintsResponse
    ]>;

Lists the blueprints in TNA's public catalog. Default page size = 20, Max Page Size = 100.

Parameters
Name Description
request IListPublicBlueprintsRequest

The request object that will be sent.

options CallOptions

Call options. See CallOptions for more details.

Returns
Type Description
Promise<[ protos.google.cloud.telcoautomation.v1alpha1.IPublicBlueprint[], protos.google.cloud.telcoautomation.v1alpha1.IListPublicBlueprintsRequest | null, protos.google.cloud.telcoautomation.v1alpha1.IListPublicBlueprintsResponse ]>

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

listPublicBlueprints(request, options, callback)

listPublicBlueprints(request: protos.google.cloud.telcoautomation.v1alpha1.IListPublicBlueprintsRequest, options: CallOptions, callback: PaginationCallback<protos.google.cloud.telcoautomation.v1alpha1.IListPublicBlueprintsRequest, protos.google.cloud.telcoautomation.v1alpha1.IListPublicBlueprintsResponse | null | undefined, protos.google.cloud.telcoautomation.v1alpha1.IPublicBlueprint>): void;
Parameters
Name Description
request IListPublicBlueprintsRequest
options CallOptions
callback PaginationCallback<protos.google.cloud.telcoautomation.v1alpha1.IListPublicBlueprintsRequest, protos.google.cloud.telcoautomation.v1alpha1.IListPublicBlueprintsResponse | null | undefined, protos.google.cloud.telcoautomation.v1alpha1.IPublicBlueprint>
Returns
Type Description
void

listPublicBlueprints(request, callback)

listPublicBlueprints(request: protos.google.cloud.telcoautomation.v1alpha1.IListPublicBlueprintsRequest, callback: PaginationCallback<protos.google.cloud.telcoautomation.v1alpha1.IListPublicBlueprintsRequest, protos.google.cloud.telcoautomation.v1alpha1.IListPublicBlueprintsResponse | null | undefined, protos.google.cloud.telcoautomation.v1alpha1.IPublicBlueprint>): void;
Parameters
Name Description
request IListPublicBlueprintsRequest
callback PaginationCallback<protos.google.cloud.telcoautomation.v1alpha1.IListPublicBlueprintsRequest, protos.google.cloud.telcoautomation.v1alpha1.IListPublicBlueprintsResponse | null | undefined, protos.google.cloud.telcoautomation.v1alpha1.IPublicBlueprint>
Returns
Type Description
void

listPublicBlueprintsAsync(request, options)

listPublicBlueprintsAsync(request?: protos.google.cloud.telcoautomation.v1alpha1.IListPublicBlueprintsRequest, options?: CallOptions): AsyncIterable<protos.google.cloud.telcoautomation.v1alpha1.IPublicBlueprint>;

Equivalent to listPublicBlueprints, but returns an iterable object.

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

Parameters
Name Description
request IListPublicBlueprintsRequest

The request object that will be sent.

options CallOptions

Call options. See CallOptions for more details.

Returns
Type Description
AsyncIterable<protos.google.cloud.telcoautomation.v1alpha1.IPublicBlueprint>

{Object} An iterable Object that allows async iteration. When you iterate the returned iterable, each element will be an object representing PublicBlueprint. The API will be called under the hood as needed, once per the page, so you can stop the iteration when you don't need more results. Please see the documentation for more details and examples.

Example

  /**
   * This snippet has been automatically generated and should be regarded as a code template only.
   * It will require modifications to work.
   * It may require correct/in-range values for request initialization.
   * TODO(developer): Uncomment these variables before running the sample.
   */
  /**
   *  Required. Parent value of public blueprint.
   *  Format should be -
   *  "projects/{project_id}/locations/{location_name}".
   */
  // const parent = 'abc123'
  /**
   *  Optional. Requested page size. Server may return fewer items than
   *  requested. If unspecified, server will pick an appropriate default.
   */
  // const pageSize = 1234
  /**
   *  Optional. A token identifying a page of results the server should return.
   */
  // const pageToken = 'abc123'

  // Imports the Telcoautomation library
  const {TelcoAutomationClient} = require('@google-cloud/telcoautomation').v1alpha1;

  // Instantiates a client
  const telcoautomationClient = new TelcoAutomationClient();

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

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

  callListPublicBlueprints();

listPublicBlueprintsStream(request, options)

listPublicBlueprintsStream(request?: protos.google.cloud.telcoautomation.v1alpha1.IListPublicBlueprintsRequest, options?: CallOptions): Transform;

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

Parameters
Name Description
request IListPublicBlueprintsRequest

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

locationPath(project, location)

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

Return a fully-qualified location resource name string.

Parameters
Name Description
project string
location string
Returns
Type Description
string

{string} Resource name string.

matchBlueprintFromBlueprintName(blueprintName)

matchBlueprintFromBlueprintName(blueprintName: string): string | number;

Parse the blueprint from Blueprint resource.

Parameter
Name Description
blueprintName string

A fully-qualified path representing Blueprint resource.

Returns
Type Description
string | number

{string} A string representing the blueprint.

matchDeploymentFromDeploymentName(deploymentName)

matchDeploymentFromDeploymentName(deploymentName: string): string | number;

Parse the deployment from Deployment resource.

Parameter
Name Description
deploymentName string

A fully-qualified path representing Deployment resource.

Returns
Type Description
string | number

{string} A string representing the deployment.

matchDeploymentFromHydratedDeploymentName(hydratedDeploymentName)

matchDeploymentFromHydratedDeploymentName(hydratedDeploymentName: string): string | number;

Parse the deployment from HydratedDeployment resource.

Parameter
Name Description
hydratedDeploymentName string

A fully-qualified path representing HydratedDeployment resource.

Returns
Type Description
string | number

{string} A string representing the deployment.

matchEdgeSlmFromEdgeSlmName(edgeSlmName)

matchEdgeSlmFromEdgeSlmName(edgeSlmName: string): string | number;

Parse the edge_slm from EdgeSlm resource.

Parameter
Name Description
edgeSlmName string

A fully-qualified path representing EdgeSlm resource.

Returns
Type Description
string | number

{string} A string representing the edge_slm.

matchHydratedDeploymentFromHydratedDeploymentName(hydratedDeploymentName)

matchHydratedDeploymentFromHydratedDeploymentName(hydratedDeploymentName: string): string | number;

Parse the hydrated_deployment from HydratedDeployment resource.

Parameter
Name Description
hydratedDeploymentName string

A fully-qualified path representing HydratedDeployment resource.

Returns
Type Description
string | number

{string} A string representing the hydrated_deployment.

matchLocationFromBlueprintName(blueprintName)

matchLocationFromBlueprintName(blueprintName: string): string | number;

Parse the location from Blueprint resource.

Parameter
Name Description
blueprintName string

A fully-qualified path representing Blueprint resource.

Returns
Type Description
string | number

{string} A string representing the location.

matchLocationFromDeploymentName(deploymentName)

matchLocationFromDeploymentName(deploymentName: string): string | number;

Parse the location from Deployment resource.

Parameter
Name Description
deploymentName string

A fully-qualified path representing Deployment resource.

Returns
Type Description
string | number

{string} A string representing the location.

matchLocationFromEdgeSlmName(edgeSlmName)

matchLocationFromEdgeSlmName(edgeSlmName: string): string | number;

Parse the location from EdgeSlm resource.

Parameter
Name Description
edgeSlmName string

A fully-qualified path representing EdgeSlm resource.

Returns
Type Description
string | number

{string} A string representing the location.

matchLocationFromHydratedDeploymentName(hydratedDeploymentName)

matchLocationFromHydratedDeploymentName(hydratedDeploymentName: string): string | number;

Parse the location from HydratedDeployment resource.

Parameter
Name Description
hydratedDeploymentName string

A fully-qualified path representing HydratedDeployment resource.

Returns
Type Description
string | number

{string} A string representing the location.

matchLocationFromLocationName(locationName)

matchLocationFromLocationName(locationName: string): string | number;

Parse the location from Location resource.

Parameter
Name Description
locationName string

A fully-qualified path representing Location resource.

Returns
Type Description
string | number

{string} A string representing the location.

matchLocationFromOrchestrationClusterName(orchestrationClusterName)

matchLocationFromOrchestrationClusterName(orchestrationClusterName: string): string | number;

Parse the location from OrchestrationCluster resource.

Parameter
Name Description
orchestrationClusterName string

A fully-qualified path representing OrchestrationCluster resource.

Returns
Type Description
string | number

{string} A string representing the location.

matchLocationFromPublicBlueprintName(publicBlueprintName)

matchLocationFromPublicBlueprintName(publicBlueprintName: string): string | number;

Parse the location from PublicBlueprint resource.

Parameter
Name Description
publicBlueprintName string

A fully-qualified path representing PublicBlueprint resource.

Returns
Type Description
string | number

{string} A string representing the location.

matchOrchestrationClusterFromBlueprintName(blueprintName)

matchOrchestrationClusterFromBlueprintName(blueprintName: string): string | number;

Parse the orchestration_cluster from Blueprint resource.

Parameter
Name Description
blueprintName string

A fully-qualified path representing Blueprint resource.

Returns
Type Description
string | number

{string} A string representing the orchestration_cluster.

matchOrchestrationClusterFromDeploymentName(deploymentName)

matchOrchestrationClusterFromDeploymentName(deploymentName: string): string | number;

Parse the orchestration_cluster from Deployment resource.

Parameter
Name Description
deploymentName string

A fully-qualified path representing Deployment resource.

Returns
Type Description
string | number

{string} A string representing the orchestration_cluster.

matchOrchestrationClusterFromHydratedDeploymentName(hydratedDeploymentName)

matchOrchestrationClusterFromHydratedDeploymentName(hydratedDeploymentName: string): string | number;

Parse the orchestration_cluster from HydratedDeployment resource.

Parameter
Name Description
hydratedDeploymentName string

A fully-qualified path representing HydratedDeployment resource.

Returns
Type Description
string | number

{string} A string representing the orchestration_cluster.

matchOrchestrationClusterFromOrchestrationClusterName(orchestrationClusterName)

matchOrchestrationClusterFromOrchestrationClusterName(orchestrationClusterName: string): string | number;

Parse the orchestration_cluster from OrchestrationCluster resource.

Parameter
Name Description
orchestrationClusterName string

A fully-qualified path representing OrchestrationCluster resource.

Returns
Type Description
string | number

{string} A string representing the orchestration_cluster.

matchProjectFromBlueprintName(blueprintName)

matchProjectFromBlueprintName(blueprintName: string): string | number;

Parse the project from Blueprint resource.

Parameter
Name Description
blueprintName string

A fully-qualified path representing Blueprint resource.

Returns
Type Description
string | number

{string} A string representing the project.

matchProjectFromDeploymentName(deploymentName)

matchProjectFromDeploymentName(deploymentName: string): string | number;

Parse the project from Deployment resource.

Parameter
Name Description
deploymentName string

A fully-qualified path representing Deployment resource.

Returns
Type Description
string | number

{string} A string representing the project.

matchProjectFromEdgeSlmName(edgeSlmName)

matchProjectFromEdgeSlmName(edgeSlmName: string): string | number;

Parse the project from EdgeSlm resource.

Parameter
Name Description
edgeSlmName string

A fully-qualified path representing EdgeSlm resource.

Returns
Type Description
string | number

{string} A string representing the project.

matchProjectFromHydratedDeploymentName(hydratedDeploymentName)

matchProjectFromHydratedDeploymentName(hydratedDeploymentName: string): string | number;

Parse the project from HydratedDeployment resource.

Parameter
Name Description
hydratedDeploymentName string

A fully-qualified path representing HydratedDeployment resource.

Returns
Type Description
string | number

{string} A string representing the project.

matchProjectFromLocationName(locationName)

matchProjectFromLocationName(locationName: string): string | number;

Parse the project from Location resource.

Parameter
Name Description
locationName string

A fully-qualified path representing Location resource.

Returns
Type Description
string | number

{string} A string representing the project.

matchProjectFromOrchestrationClusterName(orchestrationClusterName)

matchProjectFromOrchestrationClusterName(orchestrationClusterName: string): string | number;

Parse the project from OrchestrationCluster resource.

Parameter
Name Description
orchestrationClusterName string

A fully-qualified path representing OrchestrationCluster resource.

Returns
Type Description
string | number

{string} A string representing the project.

matchProjectFromProjectName(projectName)

matchProjectFromProjectName(projectName: string): string | number;

Parse the project from Project resource.

Parameter
Name Description
projectName string

A fully-qualified path representing Project resource.

Returns
Type Description
string | number

{string} A string representing the project.

matchProjectFromPublicBlueprintName(publicBlueprintName)

matchProjectFromPublicBlueprintName(publicBlueprintName: string): string | number;

Parse the project from PublicBlueprint resource.

Parameter
Name Description
publicBlueprintName string

A fully-qualified path representing PublicBlueprint resource.

Returns
Type Description
string | number

{string} A string representing the project.

matchPublicLueprintFromPublicBlueprintName(publicBlueprintName)

matchPublicLueprintFromPublicBlueprintName(publicBlueprintName: string): string | number;

Parse the public_lueprint from PublicBlueprint resource.

Parameter
Name Description
publicBlueprintName string

A fully-qualified path representing PublicBlueprint resource.

Returns
Type Description
string | number

{string} A string representing the public_lueprint.

orchestrationClusterPath(project, location, orchestrationCluster)

orchestrationClusterPath(project: string, location: string, orchestrationCluster: string): string;

Return a fully-qualified orchestrationCluster resource name string.

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

{string} Resource name string.

projectPath(project)

projectPath(project: string): string;

Return a fully-qualified project resource name string.

Parameter
Name Description
project string
Returns
Type Description
string

{string} Resource name string.

proposeBlueprint(request, options)

proposeBlueprint(request?: protos.google.cloud.telcoautomation.v1alpha1.IProposeBlueprintRequest, options?: CallOptions): Promise<[
        protos.google.cloud.telcoautomation.v1alpha1.IBlueprint,
        (protos.google.cloud.telcoautomation.v1alpha1.IProposeBlueprintRequest | undefined),
        {} | undefined
    ]>;

Proposes a blueprint for approval of changes.

Parameters
Name Description
request IProposeBlueprintRequest

The request object that will be sent.

options CallOptions

Call options. See CallOptions for more details.

Returns
Type Description
Promise<[ protos.google.cloud.telcoautomation.v1alpha1.IBlueprint, (protos.google.cloud.telcoautomation.v1alpha1.IProposeBlueprintRequest | 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 blueprint being proposed.
   */
  // const name = 'abc123'

  // Imports the Telcoautomation library
  const {TelcoAutomationClient} = require('@google-cloud/telcoautomation').v1alpha1;

  // Instantiates a client
  const telcoautomationClient = new TelcoAutomationClient();

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

    // Run request
    const response = await telcoautomationClient.proposeBlueprint(request);
    console.log(response);
  }

  callProposeBlueprint();

proposeBlueprint(request, options, callback)

proposeBlueprint(request: protos.google.cloud.telcoautomation.v1alpha1.IProposeBlueprintRequest, options: CallOptions, callback: Callback<protos.google.cloud.telcoautomation.v1alpha1.IBlueprint, protos.google.cloud.telcoautomation.v1alpha1.IProposeBlueprintRequest | null | undefined, {} | null | undefined>): void;
Parameters
Name Description
request IProposeBlueprintRequest
options CallOptions
callback Callback<protos.google.cloud.telcoautomation.v1alpha1.IBlueprint, protos.google.cloud.telcoautomation.v1alpha1.IProposeBlueprintRequest | null | undefined, {} | null | undefined>
Returns
Type Description
void

proposeBlueprint(request, callback)

proposeBlueprint(request: protos.google.cloud.telcoautomation.v1alpha1.IProposeBlueprintRequest, callback: Callback<protos.google.cloud.telcoautomation.v1alpha1.IBlueprint, protos.google.cloud.telcoautomation.v1alpha1.IProposeBlueprintRequest | null | undefined, {} | null | undefined>): void;
Parameters
Name Description
request IProposeBlueprintRequest
callback Callback<protos.google.cloud.telcoautomation.v1alpha1.IBlueprint, protos.google.cloud.telcoautomation.v1alpha1.IProposeBlueprintRequest | null | undefined, {} | null | undefined>
Returns
Type Description
void

publicBlueprintPath(project, location, publicLueprint)

publicBlueprintPath(project: string, location: string, publicLueprint: string): string;

Return a fully-qualified publicBlueprint resource name string.

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

{string} Resource name string.

rejectBlueprint(request, options)

rejectBlueprint(request?: protos.google.cloud.telcoautomation.v1alpha1.IRejectBlueprintRequest, options?: CallOptions): Promise<[
        protos.google.cloud.telcoautomation.v1alpha1.IBlueprint,
        (protos.google.cloud.telcoautomation.v1alpha1.IRejectBlueprintRequest | undefined),
        {} | undefined
    ]>;

Rejects a blueprint revision proposal and flips it back to Draft state.

Parameters
Name Description
request IRejectBlueprintRequest

The request object that will be sent.

options CallOptions

Call options. See CallOptions for more details.

Returns
Type Description
Promise<[ protos.google.cloud.telcoautomation.v1alpha1.IBlueprint, (protos.google.cloud.telcoautomation.v1alpha1.IRejectBlueprintRequest | 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 blueprint being rejected.
   */
  // const name = 'abc123'

  // Imports the Telcoautomation library
  const {TelcoAutomationClient} = require('@google-cloud/telcoautomation').v1alpha1;

  // Instantiates a client
  const telcoautomationClient = new TelcoAutomationClient();

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

    // Run request
    const response = await telcoautomationClient.rejectBlueprint(request);
    console.log(response);
  }

  callRejectBlueprint();

rejectBlueprint(request, options, callback)

rejectBlueprint(request: protos.google.cloud.telcoautomation.v1alpha1.IRejectBlueprintRequest, options: CallOptions, callback: Callback<protos.google.cloud.telcoautomation.v1alpha1.IBlueprint, protos.google.cloud.telcoautomation.v1alpha1.IRejectBlueprintRequest | null | undefined, {} | null | undefined>): void;
Parameters
Name Description
request IRejectBlueprintRequest
options CallOptions
callback Callback<protos.google.cloud.telcoautomation.v1alpha1.IBlueprint, protos.google.cloud.telcoautomation.v1alpha1.IRejectBlueprintRequest | null | undefined, {} | null | undefined>
Returns
Type Description
void

rejectBlueprint(request, callback)

rejectBlueprint(request: protos.google.cloud.telcoautomation.v1alpha1.IRejectBlueprintRequest, callback: Callback<protos.google.cloud.telcoautomation.v1alpha1.IBlueprint, protos.google.cloud.telcoautomation.v1alpha1.IRejectBlueprintRequest | null | undefined, {} | null | undefined>): void;
Parameters
Name Description
request IRejectBlueprintRequest
callback Callback<protos.google.cloud.telcoautomation.v1alpha1.IBlueprint, protos.google.cloud.telcoautomation.v1alpha1.IRejectBlueprintRequest | null | undefined, {} | null | undefined>
Returns
Type Description
void

removeDeployment(request, options)

removeDeployment(request?: protos.google.cloud.telcoautomation.v1alpha1.IRemoveDeploymentRequest, options?: CallOptions): Promise<[
        protos.google.protobuf.IEmpty,
        (protos.google.cloud.telcoautomation.v1alpha1.IRemoveDeploymentRequest | undefined),
        {} | undefined
    ]>;

Removes the deployment by marking it as DELETING. Post which deployment and it's revisions gets deleted.

Parameters
Name Description
request IRemoveDeploymentRequest

The request object that will be sent.

options CallOptions

Call options. See CallOptions for more details.

Returns
Type Description
Promise<[ protos.google.protobuf.IEmpty, (protos.google.cloud.telcoautomation.v1alpha1.IRemoveDeploymentRequest | undefined), {} | undefined ]>

{Promise} - The promise which resolves to an array. The first element of the array is an object representing Empty. 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 deployment to initiate delete.
   */
  // const name = 'abc123'

  // Imports the Telcoautomation library
  const {TelcoAutomationClient} = require('@google-cloud/telcoautomation').v1alpha1;

  // Instantiates a client
  const telcoautomationClient = new TelcoAutomationClient();

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

    // Run request
    const response = await telcoautomationClient.removeDeployment(request);
    console.log(response);
  }

  callRemoveDeployment();

removeDeployment(request, options, callback)

removeDeployment(request: protos.google.cloud.telcoautomation.v1alpha1.IRemoveDeploymentRequest, options: CallOptions, callback: Callback<protos.google.protobuf.IEmpty, protos.google.cloud.telcoautomation.v1alpha1.IRemoveDeploymentRequest | null | undefined, {} | null | undefined>): void;
Parameters
Name Description
request IRemoveDeploymentRequest
options CallOptions
callback Callback<protos.google.protobuf.IEmpty, protos.google.cloud.telcoautomation.v1alpha1.IRemoveDeploymentRequest | null | undefined, {} | null | undefined>
Returns
Type Description
void

removeDeployment(request, callback)

removeDeployment(request: protos.google.cloud.telcoautomation.v1alpha1.IRemoveDeploymentRequest, callback: Callback<protos.google.protobuf.IEmpty, protos.google.cloud.telcoautomation.v1alpha1.IRemoveDeploymentRequest | null | undefined, {} | null | undefined>): void;
Parameters
Name Description
request IRemoveDeploymentRequest
callback Callback<protos.google.protobuf.IEmpty, protos.google.cloud.telcoautomation.v1alpha1.IRemoveDeploymentRequest | null | undefined, {} | null | undefined>
Returns
Type Description
void

rollbackDeployment(request, options)

rollbackDeployment(request?: protos.google.cloud.telcoautomation.v1alpha1.IRollbackDeploymentRequest, options?: CallOptions): Promise<[
        protos.google.cloud.telcoautomation.v1alpha1.IDeployment,
        (protos.google.cloud.telcoautomation.v1alpha1.IRollbackDeploymentRequest | undefined),
        {} | undefined
    ]>;

Rollback the active deployment to the given past approved deployment revision.

Parameters
Name Description
request IRollbackDeploymentRequest

The request object that will be sent.

options CallOptions

Call options. See CallOptions for more details.

Returns
Type Description
Promise<[ protos.google.cloud.telcoautomation.v1alpha1.IDeployment, (protos.google.cloud.telcoautomation.v1alpha1.IRollbackDeploymentRequest | undefined), {} | undefined ]>

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

Example

  /**
   * This snippet has been automatically generated and should be regarded as a code template only.
   * It will require modifications to work.
   * It may require correct/in-range values for request initialization.
   * TODO(developer): Uncomment these variables before running the sample.
   */
  /**
   *  Required. Name of the deployment.
   */
  // const name = 'abc123'
  /**
   *  Required. The revision id of deployment to roll back to.
   */
  // const revisionId = 'abc123'

  // Imports the Telcoautomation library
  const {TelcoAutomationClient} = require('@google-cloud/telcoautomation').v1alpha1;

  // Instantiates a client
  const telcoautomationClient = new TelcoAutomationClient();

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

    // Run request
    const response = await telcoautomationClient.rollbackDeployment(request);
    console.log(response);
  }

  callRollbackDeployment();

rollbackDeployment(request, options, callback)

rollbackDeployment(request: protos.google.cloud.telcoautomation.v1alpha1.IRollbackDeploymentRequest, options: CallOptions, callback: Callback<protos.google.cloud.telcoautomation.v1alpha1.IDeployment, protos.google.cloud.telcoautomation.v1alpha1.IRollbackDeploymentRequest | null | undefined, {} | null | undefined>): void;
Parameters
Name Description
request IRollbackDeploymentRequest
options CallOptions
callback Callback<protos.google.cloud.telcoautomation.v1alpha1.IDeployment, protos.google.cloud.telcoautomation.v1alpha1.IRollbackDeploymentRequest | null | undefined, {} | null | undefined>
Returns
Type Description
void

rollbackDeployment(request, callback)

rollbackDeployment(request: protos.google.cloud.telcoautomation.v1alpha1.IRollbackDeploymentRequest, callback: Callback<protos.google.cloud.telcoautomation.v1alpha1.IDeployment, protos.google.cloud.telcoautomation.v1alpha1.IRollbackDeploymentRequest | null | undefined, {} | null | undefined>): void;
Parameters
Name Description
request IRollbackDeploymentRequest
callback Callback<protos.google.cloud.telcoautomation.v1alpha1.IDeployment, protos.google.cloud.telcoautomation.v1alpha1.IRollbackDeploymentRequest | null | undefined, {} | null | undefined>
Returns
Type Description
void

searchBlueprintRevisions(request, options)

searchBlueprintRevisions(request?: protos.google.cloud.telcoautomation.v1alpha1.ISearchBlueprintRevisionsRequest, options?: CallOptions): Promise<[
        protos.google.cloud.telcoautomation.v1alpha1.IBlueprint[],
        protos.google.cloud.telcoautomation.v1alpha1.ISearchBlueprintRevisionsRequest | null,
        protos.google.cloud.telcoautomation.v1alpha1.ISearchBlueprintRevisionsResponse
    ]>;

Searches across blueprint revisions.

Parameters
Name Description
request ISearchBlueprintRevisionsRequest

The request object that will be sent.

options CallOptions

Call options. See CallOptions for more details.

Returns
Type Description
Promise<[ protos.google.cloud.telcoautomation.v1alpha1.IBlueprint[], protos.google.cloud.telcoautomation.v1alpha1.ISearchBlueprintRevisionsRequest | null, protos.google.cloud.telcoautomation.v1alpha1.ISearchBlueprintRevisionsResponse ]>

{Promise} - The promise which resolves to an array. The first element of the array is Array of . The client library will perform auto-pagination by default: it will call the API as many times as needed and will merge results from all the pages into this array. Note that it can affect your quota. We recommend using searchBlueprintRevisionsAsync() method described below for async iteration which you can stop as needed. Please see the documentation for more details and examples.

searchBlueprintRevisions(request, options, callback)

searchBlueprintRevisions(request: protos.google.cloud.telcoautomation.v1alpha1.ISearchBlueprintRevisionsRequest, options: CallOptions, callback: PaginationCallback<protos.google.cloud.telcoautomation.v1alpha1.ISearchBlueprintRevisionsRequest, protos.google.cloud.telcoautomation.v1alpha1.ISearchBlueprintRevisionsResponse | null | undefined, protos.google.cloud.telcoautomation.v1alpha1.IBlueprint>): void;
Parameters
Name Description
request ISearchBlueprintRevisionsRequest
options CallOptions
callback PaginationCallback<protos.google.cloud.telcoautomation.v1alpha1.ISearchBlueprintRevisionsRequest, protos.google.cloud.telcoautomation.v1alpha1.ISearchBlueprintRevisionsResponse | null | undefined, protos.google.cloud.telcoautomation.v1alpha1.IBlueprint>
Returns
Type Description
void

searchBlueprintRevisions(request, callback)

searchBlueprintRevisions(request: protos.google.cloud.telcoautomation.v1alpha1.ISearchBlueprintRevisionsRequest, callback: PaginationCallback<protos.google.cloud.telcoautomation.v1alpha1.ISearchBlueprintRevisionsRequest, protos.google.cloud.telcoautomation.v1alpha1.ISearchBlueprintRevisionsResponse | null | undefined, protos.google.cloud.telcoautomation.v1alpha1.IBlueprint>): void;
Parameters
Name Description
request ISearchBlueprintRevisionsRequest
callback PaginationCallback<protos.google.cloud.telcoautomation.v1alpha1.ISearchBlueprintRevisionsRequest, protos.google.cloud.telcoautomation.v1alpha1.ISearchBlueprintRevisionsResponse | null | undefined, protos.google.cloud.telcoautomation.v1alpha1.IBlueprint>
Returns
Type Description
void

searchBlueprintRevisionsAsync(request, options)

searchBlueprintRevisionsAsync(request?: protos.google.cloud.telcoautomation.v1alpha1.ISearchBlueprintRevisionsRequest, options?: CallOptions): AsyncIterable<protos.google.cloud.telcoautomation.v1alpha1.IBlueprint>;

Equivalent to searchBlueprintRevisions, but returns an iterable object.

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

Parameters
Name Description
request ISearchBlueprintRevisionsRequest

The request object that will be sent.

options CallOptions

Call options. See CallOptions for more details.

Returns
Type Description
AsyncIterable<protos.google.cloud.telcoautomation.v1alpha1.IBlueprint>

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

Example

  /**
   * This snippet has been automatically generated and should be regarded as a code template only.
   * It will require modifications to work.
   * It may require correct/in-range values for request initialization.
   * TODO(developer): Uncomment these variables before running the sample.
   */
  /**
   *  Required. The name of parent orchestration cluster resource.
   *  Format should be -
   *  "projects/{project_id}/locations/{location_name}/orchestrationClusters/{orchestration_cluster}".
   */
  // const parent = 'abc123'
  /**
   *  Required. Supported queries:
   *  1. ""                       : Lists all revisions across all blueprints.
   *  2. "latest=true"            : Lists latest revisions across all blueprints.
   *  3. "name={name}"            : Lists all revisions of blueprint with name
   *  {name}.
   *  4. "name={name} latest=true": Lists latest revision of blueprint with name
   *  {name}
   */
  // const query = 'abc123'
  /**
   *  Optional. The maximum number of blueprints revisions to return per page.
   *  max page size = 100, default page size = 20.
   */
  // const pageSize = 1234
  /**
   *  Optional. The page token, received from a previous search call.
   *  It can be provided to retrieve the subsequent page.
   */
  // const pageToken = 'abc123'

  // Imports the Telcoautomation library
  const {TelcoAutomationClient} = require('@google-cloud/telcoautomation').v1alpha1;

  // Instantiates a client
  const telcoautomationClient = new TelcoAutomationClient();

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

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

  callSearchBlueprintRevisions();

searchBlueprintRevisionsStream(request, options)

searchBlueprintRevisionsStream(request?: protos.google.cloud.telcoautomation.v1alpha1.ISearchBlueprintRevisionsRequest, options?: CallOptions): Transform;

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

Parameters
Name Description
request ISearchBlueprintRevisionsRequest

The request object that will be sent.

options CallOptions

Call options. See CallOptions for more details.

Returns
Type Description
Transform

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

searchDeploymentRevisions(request, options)

searchDeploymentRevisions(request?: protos.google.cloud.telcoautomation.v1alpha1.ISearchDeploymentRevisionsRequest, options?: CallOptions): Promise<[
        protos.google.cloud.telcoautomation.v1alpha1.IDeployment[],
        protos.google.cloud.telcoautomation.v1alpha1.ISearchDeploymentRevisionsRequest | null,
        protos.google.cloud.telcoautomation.v1alpha1.ISearchDeploymentRevisionsResponse
    ]>;

Searches across deployment revisions.

Parameters
Name Description
request ISearchDeploymentRevisionsRequest

The request object that will be sent.

options CallOptions

Call options. See CallOptions for more details.

Returns
Type Description
Promise<[ protos.google.cloud.telcoautomation.v1alpha1.IDeployment[], protos.google.cloud.telcoautomation.v1alpha1.ISearchDeploymentRevisionsRequest | null, protos.google.cloud.telcoautomation.v1alpha1.ISearchDeploymentRevisionsResponse ]>

{Promise} - The promise which resolves to an array. The first element of the array is Array of . The client library will perform auto-pagination by default: it will call the API as many times as needed and will merge results from all the pages into this array. Note that it can affect your quota. We recommend using searchDeploymentRevisionsAsync() method described below for async iteration which you can stop as needed. Please see the documentation for more details and examples.

searchDeploymentRevisions(request, options, callback)

searchDeploymentRevisions(request: protos.google.cloud.telcoautomation.v1alpha1.ISearchDeploymentRevisionsRequest, options: CallOptions, callback: PaginationCallback<protos.google.cloud.telcoautomation.v1alpha1.ISearchDeploymentRevisionsRequest, protos.google.cloud.telcoautomation.v1alpha1.ISearchDeploymentRevisionsResponse | null | undefined, protos.google.cloud.telcoautomation.v1alpha1.IDeployment>): void;
Parameters
Name Description
request ISearchDeploymentRevisionsRequest
options CallOptions
callback PaginationCallback<protos.google.cloud.telcoautomation.v1alpha1.ISearchDeploymentRevisionsRequest, protos.google.cloud.telcoautomation.v1alpha1.ISearchDeploymentRevisionsResponse | null | undefined, protos.google.cloud.telcoautomation.v1alpha1.IDeployment>
Returns
Type Description
void

searchDeploymentRevisions(request, callback)

searchDeploymentRevisions(request: protos.google.cloud.telcoautomation.v1alpha1.ISearchDeploymentRevisionsRequest, callback: PaginationCallback<protos.google.cloud.telcoautomation.v1alpha1.ISearchDeploymentRevisionsRequest, protos.google.cloud.telcoautomation.v1alpha1.ISearchDeploymentRevisionsResponse | null | undefined, protos.google.cloud.telcoautomation.v1alpha1.IDeployment>): void;
Parameters
Name Description
request ISearchDeploymentRevisionsRequest
callback PaginationCallback<protos.google.cloud.telcoautomation.v1alpha1.ISearchDeploymentRevisionsRequest, protos.google.cloud.telcoautomation.v1alpha1.ISearchDeploymentRevisionsResponse | null | undefined, protos.google.cloud.telcoautomation.v1alpha1.IDeployment>
Returns
Type Description
void

searchDeploymentRevisionsAsync(request, options)

searchDeploymentRevisionsAsync(request?: protos.google.cloud.telcoautomation.v1alpha1.ISearchDeploymentRevisionsRequest, options?: CallOptions): AsyncIterable<protos.google.cloud.telcoautomation.v1alpha1.IDeployment>;

Equivalent to searchDeploymentRevisions, but returns an iterable object.

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

Parameters
Name Description
request ISearchDeploymentRevisionsRequest

The request object that will be sent.

options CallOptions

Call options. See CallOptions for more details.

Returns
Type Description
AsyncIterable<protos.google.cloud.telcoautomation.v1alpha1.IDeployment>

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

Example

  /**
   * This snippet has been automatically generated and should be regarded as a code template only.
   * It will require modifications to work.
   * It may require correct/in-range values for request initialization.
   * TODO(developer): Uncomment these variables before running the sample.
   */
  /**
   *  Required. The name of parent orchestration cluster resource.
   *  Format should be -
   *  "projects/{project_id}/locations/{location_name}/orchestrationClusters/{orchestration_cluster}".
   */
  // const parent = 'abc123'
  /**
   *  Required. Supported queries:
   *  1. ""                       : Lists all revisions across all deployments.
   *  2. "latest=true"            : Lists latest revisions across all
   *  deployments.
   *  3. "name={name}"            : Lists all revisions of deployment with name
   *  {name}.
   *  4. "name={name} latest=true": Lists latest revision of deployment with name
   *  {name}
   */
  // const query = 'abc123'
  /**
   *  Optional. The maximum number of deployment revisions to return per page.
   *  max page size = 100, default page size = 20.
   */
  // const pageSize = 1234
  /**
   *  Optional. The page token, received from a previous search call.
   *  It can be provided to retrieve the subsequent page.
   */
  // const pageToken = 'abc123'

  // Imports the Telcoautomation library
  const {TelcoAutomationClient} = require('@google-cloud/telcoautomation').v1alpha1;

  // Instantiates a client
  const telcoautomationClient = new TelcoAutomationClient();

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

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

  callSearchDeploymentRevisions();

searchDeploymentRevisionsStream(request, options)

searchDeploymentRevisionsStream(request?: protos.google.cloud.telcoautomation.v1alpha1.ISearchDeploymentRevisionsRequest, options?: CallOptions): Transform;

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

Parameters
Name Description
request ISearchDeploymentRevisionsRequest

The request object that will be sent.

options CallOptions

Call options. See CallOptions for more details.

Returns
Type Description
Transform

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

updateBlueprint(request, options)

updateBlueprint(request?: protos.google.cloud.telcoautomation.v1alpha1.IUpdateBlueprintRequest, options?: CallOptions): Promise<[
        protos.google.cloud.telcoautomation.v1alpha1.IBlueprint,
        (protos.google.cloud.telcoautomation.v1alpha1.IUpdateBlueprintRequest | undefined),
        {} | undefined
    ]>;

Updates a blueprint.

Parameters
Name Description
request IUpdateBlueprintRequest

The request object that will be sent.

options CallOptions

Call options. See CallOptions for more details.

Returns
Type Description
Promise<[ protos.google.cloud.telcoautomation.v1alpha1.IBlueprint, (protos.google.cloud.telcoautomation.v1alpha1.IUpdateBlueprintRequest | 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 `blueprint` to update.
   */
  // const blueprint = {}
  /**
   *  Required. Update mask is used to specify the fields to be overwritten in
   *  the `blueprint` resource by the update.
   */
  // const updateMask = {}

  // Imports the Telcoautomation library
  const {TelcoAutomationClient} = require('@google-cloud/telcoautomation').v1alpha1;

  // Instantiates a client
  const telcoautomationClient = new TelcoAutomationClient();

  async function callUpdateBlueprint() {
    // Construct request
    const request = {
      blueprint,
      updateMask,
    };

    // Run request
    const response = await telcoautomationClient.updateBlueprint(request);
    console.log(response);
  }

  callUpdateBlueprint();

updateBlueprint(request, options, callback)

updateBlueprint(request: protos.google.cloud.telcoautomation.v1alpha1.IUpdateBlueprintRequest, options: CallOptions, callback: Callback<protos.google.cloud.telcoautomation.v1alpha1.IBlueprint, protos.google.cloud.telcoautomation.v1alpha1.IUpdateBlueprintRequest | null | undefined, {} | null | undefined>): void;
Parameters
Name Description
request IUpdateBlueprintRequest
options CallOptions
callback Callback<protos.google.cloud.telcoautomation.v1alpha1.IBlueprint, protos.google.cloud.telcoautomation.v1alpha1.IUpdateBlueprintRequest | null | undefined, {} | null | undefined>
Returns
Type Description
void

updateBlueprint(request, callback)

updateBlueprint(request: protos.google.cloud.telcoautomation.v1alpha1.IUpdateBlueprintRequest, callback: Callback<protos.google.cloud.telcoautomation.v1alpha1.IBlueprint, protos.google.cloud.telcoautomation.v1alpha1.IUpdateBlueprintRequest | null | undefined, {} | null | undefined>): void;
Parameters
Name Description
request IUpdateBlueprintRequest
callback Callback<protos.google.cloud.telcoautomation.v1alpha1.IBlueprint, protos.google.cloud.telcoautomation.v1alpha1.IUpdateBlueprintRequest | null | undefined, {} | null | undefined>
Returns
Type Description
void

updateDeployment(request, options)

updateDeployment(request?: protos.google.cloud.telcoautomation.v1alpha1.IUpdateDeploymentRequest, options?: CallOptions): Promise<[
        protos.google.cloud.telcoautomation.v1alpha1.IDeployment,
        (protos.google.cloud.telcoautomation.v1alpha1.IUpdateDeploymentRequest | undefined),
        {} | undefined
    ]>;

Updates a deployment.

Parameters
Name Description
request IUpdateDeploymentRequest

The request object that will be sent.

options CallOptions

Call options. See CallOptions for more details.

Returns
Type Description
Promise<[ protos.google.cloud.telcoautomation.v1alpha1.IDeployment, (protos.google.cloud.telcoautomation.v1alpha1.IUpdateDeploymentRequest | 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 `deployment` to update.
   */
  // const deployment = {}
  /**
   *  Required. Update mask is used to specify the fields to be overwritten in
   *  the `deployment` resource by the update.
   */
  // const updateMask = {}

  // Imports the Telcoautomation library
  const {TelcoAutomationClient} = require('@google-cloud/telcoautomation').v1alpha1;

  // Instantiates a client
  const telcoautomationClient = new TelcoAutomationClient();

  async function callUpdateDeployment() {
    // Construct request
    const request = {
      deployment,
      updateMask,
    };

    // Run request
    const response = await telcoautomationClient.updateDeployment(request);
    console.log(response);
  }

  callUpdateDeployment();

updateDeployment(request, options, callback)

updateDeployment(request: protos.google.cloud.telcoautomation.v1alpha1.IUpdateDeploymentRequest, options: CallOptions, callback: Callback<protos.google.cloud.telcoautomation.v1alpha1.IDeployment, protos.google.cloud.telcoautomation.v1alpha1.IUpdateDeploymentRequest | null | undefined, {} | null | undefined>): void;
Parameters
Name Description
request IUpdateDeploymentRequest
options CallOptions
callback Callback<protos.google.cloud.telcoautomation.v1alpha1.IDeployment, protos.google.cloud.telcoautomation.v1alpha1.IUpdateDeploymentRequest | null | undefined, {} | null | undefined>
Returns
Type Description
void

updateDeployment(request, callback)

updateDeployment(request: protos.google.cloud.telcoautomation.v1alpha1.IUpdateDeploymentRequest, callback: Callback<protos.google.cloud.telcoautomation.v1alpha1.IDeployment, protos.google.cloud.telcoautomation.v1alpha1.IUpdateDeploymentRequest | null | undefined, {} | null | undefined>): void;
Parameters
Name Description
request IUpdateDeploymentRequest
callback Callback<protos.google.cloud.telcoautomation.v1alpha1.IDeployment, protos.google.cloud.telcoautomation.v1alpha1.IUpdateDeploymentRequest | null | undefined, {} | null | undefined>
Returns
Type Description
void

updateHydratedDeployment(request, options)

updateHydratedDeployment(request?: protos.google.cloud.telcoautomation.v1alpha1.IUpdateHydratedDeploymentRequest, options?: CallOptions): Promise<[
        protos.google.cloud.telcoautomation.v1alpha1.IHydratedDeployment,
        (protos.google.cloud.telcoautomation.v1alpha1.IUpdateHydratedDeploymentRequest | undefined),
        {} | undefined
    ]>;

Updates a hydrated deployment.

Parameters
Name Description
request IUpdateHydratedDeploymentRequest

The request object that will be sent.

options CallOptions

Call options. See CallOptions for more details.

Returns
Type Description
Promise<[ protos.google.cloud.telcoautomation.v1alpha1.IHydratedDeployment, (protos.google.cloud.telcoautomation.v1alpha1.IUpdateHydratedDeploymentRequest | 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 hydrated deployment to update.
   */
  // const hydratedDeployment = {}
  /**
   *  Required. The list of fields to update. Update mask supports a special
   *  value `*` which fully replaces (equivalent to PUT) the resource provided.
   */
  // const updateMask = {}

  // Imports the Telcoautomation library
  const {TelcoAutomationClient} = require('@google-cloud/telcoautomation').v1alpha1;

  // Instantiates a client
  const telcoautomationClient = new TelcoAutomationClient();

  async function callUpdateHydratedDeployment() {
    // Construct request
    const request = {
      hydratedDeployment,
      updateMask,
    };

    // Run request
    const response = await telcoautomationClient.updateHydratedDeployment(request);
    console.log(response);
  }

  callUpdateHydratedDeployment();

updateHydratedDeployment(request, options, callback)

updateHydratedDeployment(request: protos.google.cloud.telcoautomation.v1alpha1.IUpdateHydratedDeploymentRequest, options: CallOptions, callback: Callback<protos.google.cloud.telcoautomation.v1alpha1.IHydratedDeployment, protos.google.cloud.telcoautomation.v1alpha1.IUpdateHydratedDeploymentRequest | null | undefined, {} | null | undefined>): void;
Parameters
Name Description
request IUpdateHydratedDeploymentRequest
options CallOptions
callback Callback<protos.google.cloud.telcoautomation.v1alpha1.IHydratedDeployment, protos.google.cloud.telcoautomation.v1alpha1.IUpdateHydratedDeploymentRequest | null | undefined, {} | null | undefined>
Returns
Type Description
void

updateHydratedDeployment(request, callback)

updateHydratedDeployment(request: protos.google.cloud.telcoautomation.v1alpha1.IUpdateHydratedDeploymentRequest, callback: Callback<protos.google.cloud.telcoautomation.v1alpha1.IHydratedDeployment, protos.google.cloud.telcoautomation.v1alpha1.IUpdateHydratedDeploymentRequest | null | undefined, {} | null | undefined>): void;
Parameters
Name Description
request IUpdateHydratedDeploymentRequest
callback Callback<protos.google.cloud.telcoautomation.v1alpha1.IHydratedDeployment, protos.google.cloud.telcoautomation.v1alpha1.IUpdateHydratedDeploymentRequest | null | undefined, {} | null | undefined>
Returns
Type Description
void