Class v1.DatastreamClient (3.3.0)

Datastream service v1

Package

Constructors

(constructor)(opts, gaxInstance)

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

Construct an instance of DatastreamClient.

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

Properties

apiEndpoint

get apiEndpoint(): string;

The DNS address for this API service.

apiEndpoint

static get apiEndpoint(): string;

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

auth

auth: gax.GoogleAuth;

datastreamStub

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

descriptors

descriptors: Descriptors;

iamClient

iamClient: IamClient;

innerApiCalls

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

locationsClient

locationsClient: LocationsClient;

operationsClient

operationsClient: gax.OperationsClient;

pathTemplates

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

port

static get port(): number;

The port for this API service.

scopes

static get scopes(): string[];

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

servicePath

static get servicePath(): string;

The DNS address for this API service.

universeDomain

get universeDomain(): string;

warn

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

Methods

cancelOperation(request, 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: ''});

checkCreateConnectionProfileProgress(name)

checkCreateConnectionProfileProgress(name: string): Promise<LROperation<protos.google.cloud.datastream.v1.ConnectionProfile, protos.google.cloud.datastream.v1.OperationMetadata>>;

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

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

Returns
Type	Description
`Promise<LROperation<protos.google.cloud.datastream.v1.ConnectionProfile, protos.google.cloud.datastream.v1.OperationMetadata>>`	{Promise} - The promise which resolves to an object. The decoded operation object has result and metadata field to get information from. Please see the documentation for more details and examples.

Example


  /**
   * This snippet has been automatically generated and should be regarded as a code template only.
   * It will require modifications to work.
   * It may require correct/in-range values for request initialization.
   * TODO(developer): Uncomment these variables before running the sample.
   */
  /**
   *  Required. The parent that owns the collection of ConnectionProfiles.
   */
  // const parent = 'abc123'
  /**
   *  Required. The connection profile identifier.
   */
  // const connectionProfileId = 'abc123'
  /**
   *  Required. The connection profile resource to create.
   */
  // const connectionProfile = {}
  /**
   *  Optional. A request ID to identify requests. Specify a unique request ID
   *  so that if you must retry your request, the server will know to ignore
   *  the request if it has already been completed. The server will guarantee
   *  that for at least 60 minutes since the first request.
   *  For example, consider a situation where you make an initial request and the
   *  request times out. If you make the request again with the same request ID,
   *  the server can check if original operation with the same request ID was
   *  received, and if so, will ignore the second request. This prevents clients
   *  from accidentally creating duplicate commitments.
   *  The request ID must be a valid UUID with the exception that zero UUID is
   *  not supported (00000000-0000-0000-0000-000000000000).
   */
  // const requestId = 'abc123'
  /**
   *  Optional. Only validate the connection profile, but don't create any
   *  resources. The default is false.
   */
  // const validateOnly = true
  /**
   *  Optional. Create the connection profile without validating it.
   */
  // const force = true

  // Imports the Datastream library
  const {DatastreamClient} = require('@google-cloud/datastream').v1;

  // Instantiates a client
  const datastreamClient = new DatastreamClient();

  async function callCreateConnectionProfile() {
    // Construct request
    const request = {
      parent,
      connectionProfileId,
      connectionProfile,
    };

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

  callCreateConnectionProfile();

checkCreatePrivateConnectionProgress(name)

checkCreatePrivateConnectionProgress(name: string): Promise<LROperation<protos.google.cloud.datastream.v1.PrivateConnection, protos.google.cloud.datastream.v1.OperationMetadata>>;

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

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

Returns
Type	Description
`Promise<LROperation<protos.google.cloud.datastream.v1.PrivateConnection, protos.google.cloud.datastream.v1.OperationMetadata>>`	{Promise} - The promise which resolves to an object. The decoded operation object has result and metadata field to get information from. Please see the documentation for more details and examples.

Example


  /**
   * This snippet has been automatically generated and should be regarded as a code template only.
   * It will require modifications to work.
   * It may require correct/in-range values for request initialization.
   * TODO(developer): Uncomment these variables before running the sample.
   */
  /**
   *  Required. The parent that owns the collection of PrivateConnections.
   */
  // const parent = 'abc123'
  /**
   *  Required. The private connectivity identifier.
   */
  // const privateConnectionId = 'abc123'
  /**
   *  Required. The Private Connectivity resource to create.
   */
  // const privateConnection = {}
  /**
   *  Optional. A request ID to identify requests. Specify a unique request ID
   *  so that if you must retry your request, the server will know to ignore
   *  the request if it has already been completed. The server will guarantee
   *  that for at least 60 minutes since the first request.
   *  For example, consider a situation where you make an initial request and the
   *  request times out. If you make the request again with the same request ID,
   *  the server can check if original operation with the same request ID was
   *  received, and if so, will ignore the second request. This prevents clients
   *  from accidentally creating duplicate commitments.
   *  The request ID must be a valid UUID with the exception that zero UUID is
   *  not supported (00000000-0000-0000-0000-000000000000).
   */
  // const requestId = 'abc123'
  /**
   *  Optional. If set to true, will skip validations.
   */
  // const force = true

  // Imports the Datastream library
  const {DatastreamClient} = require('@google-cloud/datastream').v1;

  // Instantiates a client
  const datastreamClient = new DatastreamClient();

  async function callCreatePrivateConnection() {
    // Construct request
    const request = {
      parent,
      privateConnectionId,
      privateConnection,
    };

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

  callCreatePrivateConnection();

checkCreateRouteProgress(name)

checkCreateRouteProgress(name: string): Promise<LROperation<protos.google.cloud.datastream.v1.Route, protos.google.cloud.datastream.v1.OperationMetadata>>;

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

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

Returns
Type	Description
`Promise<LROperation<protos.google.cloud.datastream.v1.Route, protos.google.cloud.datastream.v1.OperationMetadata>>`	{Promise} - The promise which resolves to an object. The decoded operation object has result and metadata field to get information from. Please see the documentation for more details and examples.

Example


  /**
   * This snippet has been automatically generated and should be regarded as a code template only.
   * It will require modifications to work.
   * It may require correct/in-range values for request initialization.
   * TODO(developer): Uncomment these variables before running the sample.
   */
  /**
   *  Required. The parent that owns the collection of Routes.
   */
  // const parent = 'abc123'
  /**
   *  Required. The Route identifier.
   */
  // const routeId = 'abc123'
  /**
   *  Required. The Route resource to create.
   */
  // const route = {}
  /**
   *  Optional. A request ID to identify requests. Specify a unique request ID
   *  so that if you must retry your request, the server will know to ignore
   *  the request if it has already been completed. The server will guarantee
   *  that for at least 60 minutes since the first request.
   *  For example, consider a situation where you make an initial request and the
   *  request times out. If you make the request again with the same request ID,
   *  the server can check if original operation with the same request ID was
   *  received, and if so, will ignore the second request. This prevents clients
   *  from accidentally creating duplicate commitments.
   *  The request ID must be a valid UUID with the exception that zero UUID is
   *  not supported (00000000-0000-0000-0000-000000000000).
   */
  // const requestId = 'abc123'

  // Imports the Datastream library
  const {DatastreamClient} = require('@google-cloud/datastream').v1;

  // Instantiates a client
  const datastreamClient = new DatastreamClient();

  async function callCreateRoute() {
    // Construct request
    const request = {
      parent,
      routeId,
      route,
    };

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

  callCreateRoute();

checkCreateStreamProgress(name)

checkCreateStreamProgress(name: string): Promise<LROperation<protos.google.cloud.datastream.v1.Stream, protos.google.cloud.datastream.v1.OperationMetadata>>;

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

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

Returns
Type	Description
`Promise<LROperation<protos.google.cloud.datastream.v1.Stream, protos.google.cloud.datastream.v1.OperationMetadata>>`	{Promise} - The promise which resolves to an object. The decoded operation object has result and metadata field to get information from. Please see the documentation for more details and examples.

Example


  /**
   * This snippet has been automatically generated and should be regarded as a code template only.
   * It will require modifications to work.
   * It may require correct/in-range values for request initialization.
   * TODO(developer): Uncomment these variables before running the sample.
   */
  /**
   *  Required. The parent that owns the collection of streams.
   */
  // const parent = 'abc123'
  /**
   *  Required. The stream identifier.
   */
  // const streamId = 'abc123'
  /**
   *  Required. The stream resource to create.
   */
  // const stream = {}
  /**
   *  Optional. A request ID to identify requests. Specify a unique request ID
   *  so that if you must retry your request, the server will know to ignore
   *  the request if it has already been completed. The server will guarantee
   *  that for at least 60 minutes since the first request.
   *  For example, consider a situation where you make an initial request and the
   *  request times out. If you make the request again with the same request ID,
   *  the server can check if original operation with the same request ID was
   *  received, and if so, will ignore the second request. This prevents clients
   *  from accidentally creating duplicate commitments.
   *  The request ID must be a valid UUID with the exception that zero UUID is
   *  not supported (00000000-0000-0000-0000-000000000000).
   */
  // const requestId = 'abc123'
  /**
   *  Optional. Only validate the stream, but don't create any resources.
   *  The default is false.
   */
  // const validateOnly = true
  /**
   *  Optional. Create the stream without validating it.
   */
  // const force = true

  // Imports the Datastream library
  const {DatastreamClient} = require('@google-cloud/datastream').v1;

  // Instantiates a client
  const datastreamClient = new DatastreamClient();

  async function callCreateStream() {
    // Construct request
    const request = {
      parent,
      streamId,
      stream,
    };

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

  callCreateStream();

checkDeleteConnectionProfileProgress(name)

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

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

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

Returns
Type	Description
`Promise<LROperation<protos.google.protobuf.Empty, protos.google.cloud.datastream.v1.OperationMetadata>>`	{Promise} - The promise which resolves to an object. The decoded operation object has result and metadata field to get information from. Please see the documentation for more details and examples.

Example


  /**
   * This snippet has been automatically generated and should be regarded as a code template only.
   * It will require modifications to work.
   * It may require correct/in-range values for request initialization.
   * TODO(developer): Uncomment these variables before running the sample.
   */
  /**
   *  Required. The name of the connection profile resource to delete.
   */
  // const name = 'abc123'
  /**
   *  Optional. A request ID to identify requests. Specify a unique request ID
   *  so that if you must retry your request, the server will know to ignore
   *  the request if it has already been completed. The server will guarantee
   *  that for at least 60 minutes after the first request.
   *  For example, consider a situation where you make an initial request and the
   *  request times out. If you make the request again with the same request ID,
   *  the server can check if original operation with the same request ID was
   *  received, and if so, will ignore the second request. This prevents clients
   *  from accidentally creating duplicate commitments.
   *  The request ID must be a valid UUID with the exception that zero UUID is
   *  not supported (00000000-0000-0000-0000-000000000000).
   */
  // const requestId = 'abc123'

  // Imports the Datastream library
  const {DatastreamClient} = require('@google-cloud/datastream').v1;

  // Instantiates a client
  const datastreamClient = new DatastreamClient();

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

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

  callDeleteConnectionProfile();

checkDeletePrivateConnectionProgress(name)

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

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

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

Returns
Type	Description
`Promise<LROperation<protos.google.protobuf.Empty, protos.google.cloud.datastream.v1.OperationMetadata>>`	{Promise} - The promise which resolves to an object. The decoded operation object has result and metadata field to get information from. Please see the documentation for more details and examples.

Example


  /**
   * This snippet has been automatically generated and should be regarded as a code template only.
   * It will require modifications to work.
   * It may require correct/in-range values for request initialization.
   * TODO(developer): Uncomment these variables before running the sample.
   */
  /**
   *  Required. The name of the private connectivity configuration to delete.
   */
  // const name = 'abc123'
  /**
   *  Optional. A request ID to identify requests. Specify a unique request ID
   *  so that if you must retry your request, the server will know to ignore
   *  the request if it has already been completed. The server will guarantee
   *  that for at least 60 minutes after the first request.
   *  For example, consider a situation where you make an initial request and the
   *  request times out. If you make the request again with the same request ID,
   *  the server can check if original operation with the same request ID was
   *  received, and if so, will ignore the second request. This prevents clients
   *  from accidentally creating duplicate commitments.
   *  The request ID must be a valid UUID with the exception that zero UUID is
   *  not supported (00000000-0000-0000-0000-000000000000).
   */
  // const requestId = 'abc123'
  /**
   *  Optional. If set to true, any child routes that belong to this
   *  PrivateConnection will also be deleted.
   */
  // const force = true

  // Imports the Datastream library
  const {DatastreamClient} = require('@google-cloud/datastream').v1;

  // Instantiates a client
  const datastreamClient = new DatastreamClient();

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

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

  callDeletePrivateConnection();

checkDeleteRouteProgress(name)

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

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

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

Returns
Type	Description
`Promise<LROperation<protos.google.protobuf.Empty, protos.google.cloud.datastream.v1.OperationMetadata>>`	{Promise} - The promise which resolves to an object. The decoded operation object has result and metadata field to get information from. Please see the documentation for more details and examples.

Example


  /**
   * This snippet has been automatically generated and should be regarded as a code template only.
   * It will require modifications to work.
   * It may require correct/in-range values for request initialization.
   * TODO(developer): Uncomment these variables before running the sample.
   */
  /**
   *  Required. The name of the Route resource to delete.
   */
  // const name = 'abc123'
  /**
   *  Optional. A request ID to identify requests. Specify a unique request ID
   *  so that if you must retry your request, the server will know to ignore
   *  the request if it has already been completed. The server will guarantee
   *  that for at least 60 minutes after the first request.
   *  For example, consider a situation where you make an initial request and the
   *  request times out. If you make the request again with the same request ID,
   *  the server can check if original operation with the same request ID was
   *  received, and if so, will ignore the second request. This prevents clients
   *  from accidentally creating duplicate commitments.
   *  The request ID must be a valid UUID with the exception that zero UUID is
   *  not supported (00000000-0000-0000-0000-000000000000).
   */
  // const requestId = 'abc123'

  // Imports the Datastream library
  const {DatastreamClient} = require('@google-cloud/datastream').v1;

  // Instantiates a client
  const datastreamClient = new DatastreamClient();

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

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

  callDeleteRoute();

checkDeleteStreamProgress(name)

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

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

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

Returns
Type	Description
`Promise<LROperation<protos.google.protobuf.Empty, protos.google.cloud.datastream.v1.OperationMetadata>>`	{Promise} - The promise which resolves to an object. The decoded operation object has result and metadata field to get information from. Please see the documentation for more details and examples.

Example


  /**
   * This snippet has been automatically generated and should be regarded as a code template only.
   * It will require modifications to work.
   * It may require correct/in-range values for request initialization.
   * TODO(developer): Uncomment these variables before running the sample.
   */
  /**
   *  Required. The name of the stream resource to delete.
   */
  // const name = 'abc123'
  /**
   *  Optional. A request ID to identify requests. Specify a unique request ID
   *  so that if you must retry your request, the server will know to ignore
   *  the request if it has already been completed. The server will guarantee
   *  that for at least 60 minutes after the first request.
   *  For example, consider a situation where you make an initial request and the
   *  request times out. If you make the request again with the same request ID,
   *  the server can check if original operation with the same request ID was
   *  received, and if so, will ignore the second request. This prevents clients
   *  from accidentally creating duplicate commitments.
   *  The request ID must be a valid UUID with the exception that zero UUID is
   *  not supported (00000000-0000-0000-0000-000000000000).
   */
  // const requestId = 'abc123'

  // Imports the Datastream library
  const {DatastreamClient} = require('@google-cloud/datastream').v1;

  // Instantiates a client
  const datastreamClient = new DatastreamClient();

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

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

  callDeleteStream();

checkRunStreamProgress(name)

checkRunStreamProgress(name: string): Promise<LROperation<protos.google.cloud.datastream.v1.Stream, protos.google.cloud.datastream.v1.OperationMetadata>>;

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

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

Returns
Type	Description
`Promise<LROperation<protos.google.cloud.datastream.v1.Stream, protos.google.cloud.datastream.v1.OperationMetadata>>`	{Promise} - The promise which resolves to an object. The decoded operation object has result and metadata field to get information from. Please see the documentation for more details and examples.

Example


  /**
   * This snippet has been automatically generated and should be regarded as a code template only.
   * It will require modifications to work.
   * It may require correct/in-range values for request initialization.
   * TODO(developer): Uncomment these variables before running the sample.
   */
  /**
   *  Required. Name of the stream resource to start, in the format:
   *  projects/{project_id}/locations/{location}/streams/{stream_name}
   */
  // const name = 'abc123'
  /**
   *  Optional. The CDC strategy of the stream. If not set, the system's default
   *  value will be used.
   */
  // const cdcStrategy = {}
  /**
   *  Optional. Update the stream without validating it.
   */
  // const force = true

  // Imports the Datastream library
  const {DatastreamClient} = require('@google-cloud/datastream').v1;

  // Instantiates a client
  const datastreamClient = new DatastreamClient();

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

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

  callRunStream();

checkUpdateConnectionProfileProgress(name)

checkUpdateConnectionProfileProgress(name: string): Promise<LROperation<protos.google.cloud.datastream.v1.ConnectionProfile, protos.google.cloud.datastream.v1.OperationMetadata>>;

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

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

Returns
Type	Description
`Promise<LROperation<protos.google.cloud.datastream.v1.ConnectionProfile, protos.google.cloud.datastream.v1.OperationMetadata>>`	{Promise} - The promise which resolves to an object. The decoded operation object has result and metadata field to get information from. Please see the documentation for more details and examples.

Example


  /**
   * This snippet has been automatically generated and should be regarded as a code template only.
   * It will require modifications to work.
   * It may require correct/in-range values for request initialization.
   * TODO(developer): Uncomment these variables before running the sample.
   */
  /**
   *  Optional. Field mask is used to specify the fields to be overwritten in the
   *  ConnectionProfile resource by the update.
   *  The fields specified in the update_mask are relative to the resource, not
   *  the full request. A field will be overwritten if it is in the mask. If the
   *  user does not provide a mask then all fields will be overwritten.
   */
  // const updateMask = {}
  /**
   *  Required. The connection profile to update.
   */
  // const connectionProfile = {}
  /**
   *  Optional. A request ID to identify requests. Specify a unique request ID
   *  so that if you must retry your request, the server will know to ignore
   *  the request if it has already been completed. The server will guarantee
   *  that for at least 60 minutes since the first request.
   *  For example, consider a situation where you make an initial request and the
   *  request times out. If you make the request again with the same request ID,
   *  the server can check if original operation with the same request ID was
   *  received, and if so, will ignore the second request. This prevents clients
   *  from accidentally creating duplicate commitments.
   *  The request ID must be a valid UUID with the exception that zero UUID is
   *  not supported (00000000-0000-0000-0000-000000000000).
   */
  // const requestId = 'abc123'
  /**
   *  Optional. Only validate the connection profile, but don't update any
   *  resources. The default is false.
   */
  // const validateOnly = true
  /**
   *  Optional. Update the connection profile without validating it.
   */
  // const force = true

  // Imports the Datastream library
  const {DatastreamClient} = require('@google-cloud/datastream').v1;

  // Instantiates a client
  const datastreamClient = new DatastreamClient();

  async function callUpdateConnectionProfile() {
    // Construct request
    const request = {
      connectionProfile,
    };

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

  callUpdateConnectionProfile();

checkUpdateStreamProgress(name)

checkUpdateStreamProgress(name: string): Promise<LROperation<protos.google.cloud.datastream.v1.Stream, protos.google.cloud.datastream.v1.OperationMetadata>>;

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

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

Returns
Type	Description
`Promise<LROperation<protos.google.cloud.datastream.v1.Stream, protos.google.cloud.datastream.v1.OperationMetadata>>`	{Promise} - The promise which resolves to an object. The decoded operation object has result and metadata field to get information from. Please see the documentation for more details and examples.

Example


  /**
   * This snippet has been automatically generated and should be regarded as a code template only.
   * It will require modifications to work.
   * It may require correct/in-range values for request initialization.
   * TODO(developer): Uncomment these variables before running the sample.
   */
  /**
   *  Optional. Field mask is used to specify the fields to be overwritten in the
   *  stream resource by the update.
   *  The fields specified in the update_mask are relative to the resource, not
   *  the full request. A field will be overwritten if it is in the mask. If the
   *  user does not provide a mask then all fields will be overwritten.
   */
  // const updateMask = {}
  /**
   *  Required. The stream resource to update.
   */
  // const stream = {}
  /**
   *  Optional. A request ID to identify requests. Specify a unique request ID
   *  so that if you must retry your request, the server will know to ignore
   *  the request if it has already been completed. The server will guarantee
   *  that for at least 60 minutes since the first request.
   *  For example, consider a situation where you make an initial request and the
   *  request times out. If you make the request again with the same request ID,
   *  the server can check if original operation with the same request ID was
   *  received, and if so, will ignore the second request. This prevents clients
   *  from accidentally creating duplicate commitments.
   *  The request ID must be a valid UUID with the exception that zero UUID is
   *  not supported (00000000-0000-0000-0000-000000000000).
   */
  // const requestId = 'abc123'
  /**
   *  Optional. Only validate the stream with the changes, without actually
   *  updating it. The default is false.
   */
  // const validateOnly = true
  /**
   *  Optional. Update the stream without validating it.
   */
  // const force = true

  // Imports the Datastream library
  const {DatastreamClient} = require('@google-cloud/datastream').v1;

  // Instantiates a client
  const datastreamClient = new DatastreamClient();

  async function callUpdateStream() {
    // Construct request
    const request = {
      stream,
    };

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

  callUpdateStream();

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.

connectionProfilePath(project, location, connectionProfile)

connectionProfilePath(project: string, location: string, connectionProfile: string): string;

Return a fully-qualified connectionProfile resource name string.

Parameters
Name	Description
`project`	`string`
`location`	`string`
`connectionProfile`	`string`

Returns
Type	Description
`string`	{string} Resource name string.

createConnectionProfile(request, options)

createConnectionProfile(request?: protos.google.cloud.datastream.v1.ICreateConnectionProfileRequest, options?: CallOptions): Promise<[
        LROperation<protos.google.cloud.datastream.v1.IConnectionProfile, protos.google.cloud.datastream.v1.IOperationMetadata>,
        protos.google.longrunning.IOperation | undefined,
        {} | undefined
    ]>;

Use this method to create a connection profile in a project and location.

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

Returns
Type	Description
`Promise<[ LROperation<protos.google.cloud.datastream.v1.IConnectionProfile, protos.google.cloud.datastream.v1.IOperationMetadata>, protos.google.longrunning.IOperation \| undefined, {} \| undefined ]>`	{Promise} - The promise which resolves to an array. The first element of the array is an object representing a long running operation. Its `promise()` method returns a promise you can `await` for. Please see the documentation for more details and examples.

Example


  /**
   * This snippet has been automatically generated and should be regarded as a code template only.
   * It will require modifications to work.
   * It may require correct/in-range values for request initialization.
   * TODO(developer): Uncomment these variables before running the sample.
   */
  /**
   *  Required. The parent that owns the collection of ConnectionProfiles.
   */
  // const parent = 'abc123'
  /**
   *  Required. The connection profile identifier.
   */
  // const connectionProfileId = 'abc123'
  /**
   *  Required. The connection profile resource to create.
   */
  // const connectionProfile = {}
  /**
   *  Optional. A request ID to identify requests. Specify a unique request ID
   *  so that if you must retry your request, the server will know to ignore
   *  the request if it has already been completed. The server will guarantee
   *  that for at least 60 minutes since the first request.
   *  For example, consider a situation where you make an initial request and the
   *  request times out. If you make the request again with the same request ID,
   *  the server can check if original operation with the same request ID was
   *  received, and if so, will ignore the second request. This prevents clients
   *  from accidentally creating duplicate commitments.
   *  The request ID must be a valid UUID with the exception that zero UUID is
   *  not supported (00000000-0000-0000-0000-000000000000).
   */
  // const requestId = 'abc123'
  /**
   *  Optional. Only validate the connection profile, but don't create any
   *  resources. The default is false.
   */
  // const validateOnly = true
  /**
   *  Optional. Create the connection profile without validating it.
   */
  // const force = true

  // Imports the Datastream library
  const {DatastreamClient} = require('@google-cloud/datastream').v1;

  // Instantiates a client
  const datastreamClient = new DatastreamClient();

  async function callCreateConnectionProfile() {
    // Construct request
    const request = {
      parent,
      connectionProfileId,
      connectionProfile,
    };

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

  callCreateConnectionProfile();

createConnectionProfile(request, options, callback)

createConnectionProfile(request: protos.google.cloud.datastream.v1.ICreateConnectionProfileRequest, options: CallOptions, callback: Callback<LROperation<protos.google.cloud.datastream.v1.IConnectionProfile, protos.google.cloud.datastream.v1.IOperationMetadata>, protos.google.longrunning.IOperation | null | undefined, {} | null | undefined>): void;

Parameters
Name	Description
`request`	`ICreateConnectionProfileRequest`
`options`	`CallOptions`
`callback`	`Callback<LROperation<protos.google.cloud.datastream.v1.IConnectionProfile, protos.google.cloud.datastream.v1.IOperationMetadata>, protos.google.longrunning.IOperation \| null \| undefined, {} \| null \| undefined>`

Returns
Type	Description
`void`

createConnectionProfile(request, callback)

createConnectionProfile(request: protos.google.cloud.datastream.v1.ICreateConnectionProfileRequest, callback: Callback<LROperation<protos.google.cloud.datastream.v1.IConnectionProfile, protos.google.cloud.datastream.v1.IOperationMetadata>, protos.google.longrunning.IOperation | null | undefined, {} | null | undefined>): void;

Parameters
Name	Description
`request`	`ICreateConnectionProfileRequest`
`callback`	`Callback<LROperation<protos.google.cloud.datastream.v1.IConnectionProfile, protos.google.cloud.datastream.v1.IOperationMetadata>, protos.google.longrunning.IOperation \| null \| undefined, {} \| null \| undefined>`

Returns
Type	Description
`void`

createPrivateConnection(request, options)

createPrivateConnection(request?: protos.google.cloud.datastream.v1.ICreatePrivateConnectionRequest, options?: CallOptions): Promise<[
        LROperation<protos.google.cloud.datastream.v1.IPrivateConnection, protos.google.cloud.datastream.v1.IOperationMetadata>,
        protos.google.longrunning.IOperation | undefined,
        {} | undefined
    ]>;

Use this method to create a private connectivity configuration.

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

Returns
Type	Description
`Promise<[ LROperation<protos.google.cloud.datastream.v1.IPrivateConnection, protos.google.cloud.datastream.v1.IOperationMetadata>, protos.google.longrunning.IOperation \| undefined, {} \| undefined ]>`	{Promise} - The promise which resolves to an array. The first element of the array is an object representing a long running operation. Its `promise()` method returns a promise you can `await` for. Please see the documentation for more details and examples.

Example


  /**
   * This snippet has been automatically generated and should be regarded as a code template only.
   * It will require modifications to work.
   * It may require correct/in-range values for request initialization.
   * TODO(developer): Uncomment these variables before running the sample.
   */
  /**
   *  Required. The parent that owns the collection of PrivateConnections.
   */
  // const parent = 'abc123'
  /**
   *  Required. The private connectivity identifier.
   */
  // const privateConnectionId = 'abc123'
  /**
   *  Required. The Private Connectivity resource to create.
   */
  // const privateConnection = {}
  /**
   *  Optional. A request ID to identify requests. Specify a unique request ID
   *  so that if you must retry your request, the server will know to ignore
   *  the request if it has already been completed. The server will guarantee
   *  that for at least 60 minutes since the first request.
   *  For example, consider a situation where you make an initial request and the
   *  request times out. If you make the request again with the same request ID,
   *  the server can check if original operation with the same request ID was
   *  received, and if so, will ignore the second request. This prevents clients
   *  from accidentally creating duplicate commitments.
   *  The request ID must be a valid UUID with the exception that zero UUID is
   *  not supported (00000000-0000-0000-0000-000000000000).
   */
  // const requestId = 'abc123'
  /**
   *  Optional. If set to true, will skip validations.
   */
  // const force = true

  // Imports the Datastream library
  const {DatastreamClient} = require('@google-cloud/datastream').v1;

  // Instantiates a client
  const datastreamClient = new DatastreamClient();

  async function callCreatePrivateConnection() {
    // Construct request
    const request = {
      parent,
      privateConnectionId,
      privateConnection,
    };

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

  callCreatePrivateConnection();

createPrivateConnection(request, options, callback)

createPrivateConnection(request: protos.google.cloud.datastream.v1.ICreatePrivateConnectionRequest, options: CallOptions, callback: Callback<LROperation<protos.google.cloud.datastream.v1.IPrivateConnection, protos.google.cloud.datastream.v1.IOperationMetadata>, protos.google.longrunning.IOperation | null | undefined, {} | null | undefined>): void;

Parameters
Name	Description
`request`	`ICreatePrivateConnectionRequest`
`options`	`CallOptions`
`callback`	`Callback<LROperation<protos.google.cloud.datastream.v1.IPrivateConnection, protos.google.cloud.datastream.v1.IOperationMetadata>, protos.google.longrunning.IOperation \| null \| undefined, {} \| null \| undefined>`

Returns
Type	Description
`void`

createPrivateConnection(request, callback)

createPrivateConnection(request: protos.google.cloud.datastream.v1.ICreatePrivateConnectionRequest, callback: Callback<LROperation<protos.google.cloud.datastream.v1.IPrivateConnection, protos.google.cloud.datastream.v1.IOperationMetadata>, protos.google.longrunning.IOperation | null | undefined, {} | null | undefined>): void;

Parameters
Name	Description
`request`	`ICreatePrivateConnectionRequest`
`callback`	`Callback<LROperation<protos.google.cloud.datastream.v1.IPrivateConnection, protos.google.cloud.datastream.v1.IOperationMetadata>, protos.google.longrunning.IOperation \| null \| undefined, {} \| null \| undefined>`

Returns
Type	Description
`void`

createRoute(request, options)

createRoute(request?: protos.google.cloud.datastream.v1.ICreateRouteRequest, options?: CallOptions): Promise<[
        LROperation<protos.google.cloud.datastream.v1.IRoute, protos.google.cloud.datastream.v1.IOperationMetadata>,
        protos.google.longrunning.IOperation | undefined,
        {} | undefined
    ]>;

Use this method to create a route for a private connectivity configuration in a project and location.

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

Returns
Type	Description
`Promise<[ LROperation<protos.google.cloud.datastream.v1.IRoute, protos.google.cloud.datastream.v1.IOperationMetadata>, protos.google.longrunning.IOperation \| undefined, {} \| undefined ]>`	{Promise} - The promise which resolves to an array. The first element of the array is an object representing a long running operation. Its `promise()` method returns a promise you can `await` for. Please see the documentation for more details and examples.

Example


  /**
   * This snippet has been automatically generated and should be regarded as a code template only.
   * It will require modifications to work.
   * It may require correct/in-range values for request initialization.
   * TODO(developer): Uncomment these variables before running the sample.
   */
  /**
   *  Required. The parent that owns the collection of Routes.
   */
  // const parent = 'abc123'
  /**
   *  Required. The Route identifier.
   */
  // const routeId = 'abc123'
  /**
   *  Required. The Route resource to create.
   */
  // const route = {}
  /**
   *  Optional. A request ID to identify requests. Specify a unique request ID
   *  so that if you must retry your request, the server will know to ignore
   *  the request if it has already been completed. The server will guarantee
   *  that for at least 60 minutes since the first request.
   *  For example, consider a situation where you make an initial request and the
   *  request times out. If you make the request again with the same request ID,
   *  the server can check if original operation with the same request ID was
   *  received, and if so, will ignore the second request. This prevents clients
   *  from accidentally creating duplicate commitments.
   *  The request ID must be a valid UUID with the exception that zero UUID is
   *  not supported (00000000-0000-0000-0000-000000000000).
   */
  // const requestId = 'abc123'

  // Imports the Datastream library
  const {DatastreamClient} = require('@google-cloud/datastream').v1;

  // Instantiates a client
  const datastreamClient = new DatastreamClient();

  async function callCreateRoute() {
    // Construct request
    const request = {
      parent,
      routeId,
      route,
    };

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

  callCreateRoute();

createRoute(request, options, callback)

createRoute(request: protos.google.cloud.datastream.v1.ICreateRouteRequest, options: CallOptions, callback: Callback<LROperation<protos.google.cloud.datastream.v1.IRoute, protos.google.cloud.datastream.v1.IOperationMetadata>, protos.google.longrunning.IOperation | null | undefined, {} | null | undefined>): void;

Parameters
Name	Description
`request`	`ICreateRouteRequest`
`options`	`CallOptions`
`callback`	`Callback<LROperation<protos.google.cloud.datastream.v1.IRoute, protos.google.cloud.datastream.v1.IOperationMetadata>, protos.google.longrunning.IOperation \| null \| undefined, {} \| null \| undefined>`

Returns
Type	Description
`void`

createRoute(request, callback)

createRoute(request: protos.google.cloud.datastream.v1.ICreateRouteRequest, callback: Callback<LROperation<protos.google.cloud.datastream.v1.IRoute, protos.google.cloud.datastream.v1.IOperationMetadata>, protos.google.longrunning.IOperation | null | undefined, {} | null | undefined>): void;

Parameters
Name	Description
`request`	`ICreateRouteRequest`
`callback`	`Callback<LROperation<protos.google.cloud.datastream.v1.IRoute, protos.google.cloud.datastream.v1.IOperationMetadata>, protos.google.longrunning.IOperation \| null \| undefined, {} \| null \| undefined>`

Returns
Type	Description
`void`

createStream(request, options)

createStream(request?: protos.google.cloud.datastream.v1.ICreateStreamRequest, options?: CallOptions): Promise<[
        LROperation<protos.google.cloud.datastream.v1.IStream, protos.google.cloud.datastream.v1.IOperationMetadata>,
        protos.google.longrunning.IOperation | undefined,
        {} | undefined
    ]>;

Use this method to create a stream.

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

Returns
Type	Description
`Promise<[ LROperation<protos.google.cloud.datastream.v1.IStream, protos.google.cloud.datastream.v1.IOperationMetadata>, protos.google.longrunning.IOperation \| undefined, {} \| undefined ]>`	{Promise} - The promise which resolves to an array. The first element of the array is an object representing a long running operation. Its `promise()` method returns a promise you can `await` for. Please see the documentation for more details and examples.

Example


  /**
   * This snippet has been automatically generated and should be regarded as a code template only.
   * It will require modifications to work.
   * It may require correct/in-range values for request initialization.
   * TODO(developer): Uncomment these variables before running the sample.
   */
  /**
   *  Required. The parent that owns the collection of streams.
   */
  // const parent = 'abc123'
  /**
   *  Required. The stream identifier.
   */
  // const streamId = 'abc123'
  /**
   *  Required. The stream resource to create.
   */
  // const stream = {}
  /**
   *  Optional. A request ID to identify requests. Specify a unique request ID
   *  so that if you must retry your request, the server will know to ignore
   *  the request if it has already been completed. The server will guarantee
   *  that for at least 60 minutes since the first request.
   *  For example, consider a situation where you make an initial request and the
   *  request times out. If you make the request again with the same request ID,
   *  the server can check if original operation with the same request ID was
   *  received, and if so, will ignore the second request. This prevents clients
   *  from accidentally creating duplicate commitments.
   *  The request ID must be a valid UUID with the exception that zero UUID is
   *  not supported (00000000-0000-0000-0000-000000000000).
   */
  // const requestId = 'abc123'
  /**
   *  Optional. Only validate the stream, but don't create any resources.
   *  The default is false.
   */
  // const validateOnly = true
  /**
   *  Optional. Create the stream without validating it.
   */
  // const force = true

  // Imports the Datastream library
  const {DatastreamClient} = require('@google-cloud/datastream').v1;

  // Instantiates a client
  const datastreamClient = new DatastreamClient();

  async function callCreateStream() {
    // Construct request
    const request = {
      parent,
      streamId,
      stream,
    };

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

  callCreateStream();

createStream(request, options, callback)

createStream(request: protos.google.cloud.datastream.v1.ICreateStreamRequest, options: CallOptions, callback: Callback<LROperation<protos.google.cloud.datastream.v1.IStream, protos.google.cloud.datastream.v1.IOperationMetadata>, protos.google.longrunning.IOperation | null | undefined, {} | null | undefined>): void;

Parameters
Name	Description
`request`	`ICreateStreamRequest`
`options`	`CallOptions`
`callback`	`Callback<LROperation<protos.google.cloud.datastream.v1.IStream, protos.google.cloud.datastream.v1.IOperationMetadata>, protos.google.longrunning.IOperation \| null \| undefined, {} \| null \| undefined>`

Returns
Type	Description
`void`

createStream(request, callback)

createStream(request: protos.google.cloud.datastream.v1.ICreateStreamRequest, callback: Callback<LROperation<protos.google.cloud.datastream.v1.IStream, protos.google.cloud.datastream.v1.IOperationMetadata>, protos.google.longrunning.IOperation | null | undefined, {} | null | undefined>): void;

Parameters
Name	Description
`request`	`ICreateStreamRequest`
`callback`	`Callback<LROperation<protos.google.cloud.datastream.v1.IStream, protos.google.cloud.datastream.v1.IOperationMetadata>, protos.google.longrunning.IOperation \| null \| undefined, {} \| null \| undefined>`

Returns
Type	Description
`void`

deleteConnectionProfile(request, options)

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

Use this method to delete a connection profile.

Parameters
Name	Description
`request`	`IDeleteConnectionProfileRequest` 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.datastream.v1.IOperationMetadata>, protos.google.longrunning.IOperation \| undefined, {} \| undefined ]>`	{Promise} - The promise which resolves to an array. The first element of the array is an object representing a long running operation. Its `promise()` method returns a promise you can `await` for. Please see the documentation for more details and examples.

Example


  /**
   * This snippet has been automatically generated and should be regarded as a code template only.
   * It will require modifications to work.
   * It may require correct/in-range values for request initialization.
   * TODO(developer): Uncomment these variables before running the sample.
   */
  /**
   *  Required. The name of the connection profile resource to delete.
   */
  // const name = 'abc123'
  /**
   *  Optional. A request ID to identify requests. Specify a unique request ID
   *  so that if you must retry your request, the server will know to ignore
   *  the request if it has already been completed. The server will guarantee
   *  that for at least 60 minutes after the first request.
   *  For example, consider a situation where you make an initial request and the
   *  request times out. If you make the request again with the same request ID,
   *  the server can check if original operation with the same request ID was
   *  received, and if so, will ignore the second request. This prevents clients
   *  from accidentally creating duplicate commitments.
   *  The request ID must be a valid UUID with the exception that zero UUID is
   *  not supported (00000000-0000-0000-0000-000000000000).
   */
  // const requestId = 'abc123'

  // Imports the Datastream library
  const {DatastreamClient} = require('@google-cloud/datastream').v1;

  // Instantiates a client
  const datastreamClient = new DatastreamClient();

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

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

  callDeleteConnectionProfile();

deleteConnectionProfile(request, options, callback)

deleteConnectionProfile(request: protos.google.cloud.datastream.v1.IDeleteConnectionProfileRequest, options: CallOptions, callback: Callback<LROperation<protos.google.protobuf.IEmpty, protos.google.cloud.datastream.v1.IOperationMetadata>, protos.google.longrunning.IOperation | null | undefined, {} | null | undefined>): void;

Parameters
Name	Description
`request`	`IDeleteConnectionProfileRequest`
`options`	`CallOptions`
`callback`	`Callback<LROperation<protos.google.protobuf.IEmpty, protos.google.cloud.datastream.v1.IOperationMetadata>, protos.google.longrunning.IOperation \| null \| undefined, {} \| null \| undefined>`

Returns
Type	Description
`void`

deleteConnectionProfile(request, callback)

deleteConnectionProfile(request: protos.google.cloud.datastream.v1.IDeleteConnectionProfileRequest, callback: Callback<LROperation<protos.google.protobuf.IEmpty, protos.google.cloud.datastream.v1.IOperationMetadata>, protos.google.longrunning.IOperation | null | undefined, {} | null | undefined>): void;

Parameters
Name	Description
`request`	`IDeleteConnectionProfileRequest`
`callback`	`Callback<LROperation<protos.google.protobuf.IEmpty, protos.google.cloud.datastream.v1.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: ''});

deletePrivateConnection(request, options)

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

Use this method to delete a private connectivity configuration.

Parameters
Name	Description
`request`	`IDeletePrivateConnectionRequest` 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.datastream.v1.IOperationMetadata>, protos.google.longrunning.IOperation \| undefined, {} \| undefined ]>`	{Promise} - The promise which resolves to an array. The first element of the array is an object representing a long running operation. Its `promise()` method returns a promise you can `await` for. Please see the documentation for more details and examples.

Example


  /**
   * This snippet has been automatically generated and should be regarded as a code template only.
   * It will require modifications to work.
   * It may require correct/in-range values for request initialization.
   * TODO(developer): Uncomment these variables before running the sample.
   */
  /**
   *  Required. The name of the private connectivity configuration to delete.
   */
  // const name = 'abc123'
  /**
   *  Optional. A request ID to identify requests. Specify a unique request ID
   *  so that if you must retry your request, the server will know to ignore
   *  the request if it has already been completed. The server will guarantee
   *  that for at least 60 minutes after the first request.
   *  For example, consider a situation where you make an initial request and the
   *  request times out. If you make the request again with the same request ID,
   *  the server can check if original operation with the same request ID was
   *  received, and if so, will ignore the second request. This prevents clients
   *  from accidentally creating duplicate commitments.
   *  The request ID must be a valid UUID with the exception that zero UUID is
   *  not supported (00000000-0000-0000-0000-000000000000).
   */
  // const requestId = 'abc123'
  /**
   *  Optional. If set to true, any child routes that belong to this
   *  PrivateConnection will also be deleted.
   */
  // const force = true

  // Imports the Datastream library
  const {DatastreamClient} = require('@google-cloud/datastream').v1;

  // Instantiates a client
  const datastreamClient = new DatastreamClient();

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

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

  callDeletePrivateConnection();

deletePrivateConnection(request, options, callback)

deletePrivateConnection(request: protos.google.cloud.datastream.v1.IDeletePrivateConnectionRequest, options: CallOptions, callback: Callback<LROperation<protos.google.protobuf.IEmpty, protos.google.cloud.datastream.v1.IOperationMetadata>, protos.google.longrunning.IOperation | null | undefined, {} | null | undefined>): void;

Parameters
Name	Description
`request`	`IDeletePrivateConnectionRequest`
`options`	`CallOptions`
`callback`	`Callback<LROperation<protos.google.protobuf.IEmpty, protos.google.cloud.datastream.v1.IOperationMetadata>, protos.google.longrunning.IOperation \| null \| undefined, {} \| null \| undefined>`

Returns
Type	Description
`void`

deletePrivateConnection(request, callback)

deletePrivateConnection(request: protos.google.cloud.datastream.v1.IDeletePrivateConnectionRequest, callback: Callback<LROperation<protos.google.protobuf.IEmpty, protos.google.cloud.datastream.v1.IOperationMetadata>, protos.google.longrunning.IOperation | null | undefined, {} | null | undefined>): void;

Parameters
Name	Description
`request`	`IDeletePrivateConnectionRequest`
`callback`	`Callback<LROperation<protos.google.protobuf.IEmpty, protos.google.cloud.datastream.v1.IOperationMetadata>, protos.google.longrunning.IOperation \| null \| undefined, {} \| null \| undefined>`

Returns
Type	Description
`void`

deleteRoute(request, options)

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

Use this method to delete a route.

Parameters
Name	Description
`request`	`IDeleteRouteRequest` 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.datastream.v1.IOperationMetadata>, protos.google.longrunning.IOperation \| undefined, {} \| undefined ]>`	{Promise} - The promise which resolves to an array. The first element of the array is an object representing a long running operation. Its `promise()` method returns a promise you can `await` for. Please see the documentation for more details and examples.

Example


  /**
   * This snippet has been automatically generated and should be regarded as a code template only.
   * It will require modifications to work.
   * It may require correct/in-range values for request initialization.
   * TODO(developer): Uncomment these variables before running the sample.
   */
  /**
   *  Required. The name of the Route resource to delete.
   */
  // const name = 'abc123'
  /**
   *  Optional. A request ID to identify requests. Specify a unique request ID
   *  so that if you must retry your request, the server will know to ignore
   *  the request if it has already been completed. The server will guarantee
   *  that for at least 60 minutes after the first request.
   *  For example, consider a situation where you make an initial request and the
   *  request times out. If you make the request again with the same request ID,
   *  the server can check if original operation with the same request ID was
   *  received, and if so, will ignore the second request. This prevents clients
   *  from accidentally creating duplicate commitments.
   *  The request ID must be a valid UUID with the exception that zero UUID is
   *  not supported (00000000-0000-0000-0000-000000000000).
   */
  // const requestId = 'abc123'

  // Imports the Datastream library
  const {DatastreamClient} = require('@google-cloud/datastream').v1;

  // Instantiates a client
  const datastreamClient = new DatastreamClient();

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

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

  callDeleteRoute();

deleteRoute(request, options, callback)

deleteRoute(request: protos.google.cloud.datastream.v1.IDeleteRouteRequest, options: CallOptions, callback: Callback<LROperation<protos.google.protobuf.IEmpty, protos.google.cloud.datastream.v1.IOperationMetadata>, protos.google.longrunning.IOperation | null | undefined, {} | null | undefined>): void;

Parameters
Name	Description
`request`	`IDeleteRouteRequest`
`options`	`CallOptions`
`callback`	`Callback<LROperation<protos.google.protobuf.IEmpty, protos.google.cloud.datastream.v1.IOperationMetadata>, protos.google.longrunning.IOperation \| null \| undefined, {} \| null \| undefined>`

Returns
Type	Description
`void`

deleteRoute(request, callback)

deleteRoute(request: protos.google.cloud.datastream.v1.IDeleteRouteRequest, callback: Callback<LROperation<protos.google.protobuf.IEmpty, protos.google.cloud.datastream.v1.IOperationMetadata>, protos.google.longrunning.IOperation | null | undefined, {} | null | undefined>): void;

Parameters
Name	Description
`request`	`IDeleteRouteRequest`
`callback`	`Callback<LROperation<protos.google.protobuf.IEmpty, protos.google.cloud.datastream.v1.IOperationMetadata>, protos.google.longrunning.IOperation \| null \| undefined, {} \| null \| undefined>`

Returns
Type	Description
`void`

deleteStream(request, options)

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

Use this method to delete a stream.

Parameters
Name	Description
`request`	`IDeleteStreamRequest` 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.datastream.v1.IOperationMetadata>, protos.google.longrunning.IOperation \| undefined, {} \| undefined ]>`	{Promise} - The promise which resolves to an array. The first element of the array is an object representing a long running operation. Its `promise()` method returns a promise you can `await` for. Please see the documentation for more details and examples.

Example


  /**
   * This snippet has been automatically generated and should be regarded as a code template only.
   * It will require modifications to work.
   * It may require correct/in-range values for request initialization.
   * TODO(developer): Uncomment these variables before running the sample.
   */
  /**
   *  Required. The name of the stream resource to delete.
   */
  // const name = 'abc123'
  /**
   *  Optional. A request ID to identify requests. Specify a unique request ID
   *  so that if you must retry your request, the server will know to ignore
   *  the request if it has already been completed. The server will guarantee
   *  that for at least 60 minutes after the first request.
   *  For example, consider a situation where you make an initial request and the
   *  request times out. If you make the request again with the same request ID,
   *  the server can check if original operation with the same request ID was
   *  received, and if so, will ignore the second request. This prevents clients
   *  from accidentally creating duplicate commitments.
   *  The request ID must be a valid UUID with the exception that zero UUID is
   *  not supported (00000000-0000-0000-0000-000000000000).
   */
  // const requestId = 'abc123'

  // Imports the Datastream library
  const {DatastreamClient} = require('@google-cloud/datastream').v1;

  // Instantiates a client
  const datastreamClient = new DatastreamClient();

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

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

  callDeleteStream();

deleteStream(request, options, callback)

deleteStream(request: protos.google.cloud.datastream.v1.IDeleteStreamRequest, options: CallOptions, callback: Callback<LROperation<protos.google.protobuf.IEmpty, protos.google.cloud.datastream.v1.IOperationMetadata>, protos.google.longrunning.IOperation | null | undefined, {} | null | undefined>): void;

Parameters
Name	Description
`request`	`IDeleteStreamRequest`
`options`	`CallOptions`
`callback`	`Callback<LROperation<protos.google.protobuf.IEmpty, protos.google.cloud.datastream.v1.IOperationMetadata>, protos.google.longrunning.IOperation \| null \| undefined, {} \| null \| undefined>`

Returns
Type	Description
`void`

deleteStream(request, callback)

deleteStream(request: protos.google.cloud.datastream.v1.IDeleteStreamRequest, callback: Callback<LROperation<protos.google.protobuf.IEmpty, protos.google.cloud.datastream.v1.IOperationMetadata>, protos.google.longrunning.IOperation | null | undefined, {} | null | undefined>): void;

Parameters
Name	Description
`request`	`IDeleteStreamRequest`
`callback`	`Callback<LROperation<protos.google.protobuf.IEmpty, protos.google.cloud.datastream.v1.IOperationMetadata>, protos.google.longrunning.IOperation \| null \| undefined, {} \| null \| undefined>`

Returns
Type	Description
`void`

discoverConnectionProfile(request, options)

discoverConnectionProfile(request?: protos.google.cloud.datastream.v1.IDiscoverConnectionProfileRequest, options?: CallOptions): Promise<[
        protos.google.cloud.datastream.v1.IDiscoverConnectionProfileResponse,
        (protos.google.cloud.datastream.v1.IDiscoverConnectionProfileRequest | undefined),
        {} | undefined
    ]>;

Use this method to discover a connection profile. The discover API call exposes the data objects and metadata belonging to the profile. Typically, a request returns children data objects of a parent data object that's optionally supplied in the request.

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

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

Example


  /**
   * This snippet has been automatically generated and should be regarded as a code template only.
   * It will require modifications to work.
   * It may require correct/in-range values for request initialization.
   * TODO(developer): Uncomment these variables before running the sample.
   */
  /**
   *  Required. The parent resource of the connection profile type. Must be in
   *  the format `projects/* /locations/*`.
   */
  // const parent = 'abc123'
  /**
   *  An ad-hoc connection profile configuration.
   */
  // const connectionProfile = {}
  /**
   *  A reference to an existing connection profile.
   */
  // const connectionProfileName = 'abc123'
  /**
   *  Whether to retrieve the full hierarchy of data objects (TRUE) or only the
   *  current level (FALSE).
   */
  // const fullHierarchy = true
  /**
   *  The number of hierarchy levels below the current level to be retrieved.
   */
  // const hierarchyDepth = 1234
  /**
   *  Oracle RDBMS to enrich with child data objects and metadata.
   */
  // const oracleRdbms = {}
  /**
   *  MySQL RDBMS to enrich with child data objects and metadata.
   */
  // const mysqlRdbms = {}
  /**
   *  PostgreSQL RDBMS to enrich with child data objects and metadata.
   */
  // const postgresqlRdbms = {}
  /**
   *  SQLServer RDBMS to enrich with child data objects and metadata.
   */
  // const sqlServerRdbms = {}

  // Imports the Datastream library
  const {DatastreamClient} = require('@google-cloud/datastream').v1;

  // Instantiates a client
  const datastreamClient = new DatastreamClient();

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

    // Run request
    const response = await datastreamClient.discoverConnectionProfile(request);
    console.log(response);
  }

  callDiscoverConnectionProfile();

discoverConnectionProfile(request, options, callback)

discoverConnectionProfile(request: protos.google.cloud.datastream.v1.IDiscoverConnectionProfileRequest, options: CallOptions, callback: Callback<protos.google.cloud.datastream.v1.IDiscoverConnectionProfileResponse, protos.google.cloud.datastream.v1.IDiscoverConnectionProfileRequest | null | undefined, {} | null | undefined>): void;

Parameters
Name	Description
`request`	`IDiscoverConnectionProfileRequest`
`options`	`CallOptions`
`callback`	`Callback<protos.google.cloud.datastream.v1.IDiscoverConnectionProfileResponse, protos.google.cloud.datastream.v1.IDiscoverConnectionProfileRequest \| null \| undefined, {} \| null \| undefined>`

Returns
Type	Description
`void`

discoverConnectionProfile(request, callback)

discoverConnectionProfile(request: protos.google.cloud.datastream.v1.IDiscoverConnectionProfileRequest, callback: Callback<protos.google.cloud.datastream.v1.IDiscoverConnectionProfileResponse, protos.google.cloud.datastream.v1.IDiscoverConnectionProfileRequest | null | undefined, {} | null | undefined>): void;

Parameters
Name	Description
`request`	`IDiscoverConnectionProfileRequest`
`callback`	`Callback<protos.google.cloud.datastream.v1.IDiscoverConnectionProfileResponse, protos.google.cloud.datastream.v1.IDiscoverConnectionProfileRequest \| null \| undefined, {} \| null \| undefined>`

Returns
Type	Description
`void`

fetchStaticIps(request, options)

fetchStaticIps(request?: protos.google.cloud.datastream.v1.IFetchStaticIpsRequest, options?: CallOptions): Promise<[
        string[],
        protos.google.cloud.datastream.v1.IFetchStaticIpsRequest | null,
        protos.google.cloud.datastream.v1.IFetchStaticIpsResponse
    ]>;

The FetchStaticIps API call exposes the static IP addresses used by Datastream.

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

Returns

Type Description

Promise<[
        string[],
        protos.google.cloud.datastream.v1.IFetchStaticIpsRequest | null,
        protos.google.cloud.datastream.v1.IFetchStaticIpsResponse
    ]>

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

fetchStaticIps(request, options, callback)

fetchStaticIps(request: protos.google.cloud.datastream.v1.IFetchStaticIpsRequest, options: CallOptions, callback: PaginationCallback<protos.google.cloud.datastream.v1.IFetchStaticIpsRequest, protos.google.cloud.datastream.v1.IFetchStaticIpsResponse | null | undefined, string>): void;

Parameters
Name	Description
`request`	`IFetchStaticIpsRequest`
`options`	`CallOptions`
`callback`	`PaginationCallback<protos.google.cloud.datastream.v1.IFetchStaticIpsRequest, protos.google.cloud.datastream.v1.IFetchStaticIpsResponse \| null \| undefined, string>`

Returns
Type	Description
`void`

fetchStaticIps(request, callback)

fetchStaticIps(request: protos.google.cloud.datastream.v1.IFetchStaticIpsRequest, callback: PaginationCallback<protos.google.cloud.datastream.v1.IFetchStaticIpsRequest, protos.google.cloud.datastream.v1.IFetchStaticIpsResponse | null | undefined, string>): void;

Parameters
Name	Description
`request`	`IFetchStaticIpsRequest`
`callback`	`PaginationCallback<protos.google.cloud.datastream.v1.IFetchStaticIpsRequest, protos.google.cloud.datastream.v1.IFetchStaticIpsResponse \| null \| undefined, string>`

Returns
Type	Description
`void`

fetchStaticIpsAsync(request, options)

fetchStaticIpsAsync(request?: protos.google.cloud.datastream.v1.IFetchStaticIpsRequest, options?: CallOptions): AsyncIterable<string>;

Equivalent to fetchStaticIps, but returns an iterable object.

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

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

Returns
Type	Description
`AsyncIterable<string>`	{Object} An iterable Object that allows async iteration. When you iterate the returned iterable, each element will be an object representing string. 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 resource name for the location for which static IPs should be
   *  returned. Must be in the format `projects/* /locations/*`.
   */
  // const name = 'abc123'
  /**
   *  Maximum number of Ips to return, will likely not be specified.
   */
  // const pageSize = 1234
  /**
   *  A page token, received from a previous `ListStaticIps` call.
   *  will likely not be specified.
   */
  // const pageToken = 'abc123'

  // Imports the Datastream library
  const {DatastreamClient} = require('@google-cloud/datastream').v1;

  // Instantiates a client
  const datastreamClient = new DatastreamClient();

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

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

  callFetchStaticIps();

fetchStaticIpsStream(request, options)

fetchStaticIpsStream(request?: protos.google.cloud.datastream.v1.IFetchStaticIpsRequest, options?: CallOptions): Transform;

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

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

getConnectionProfile(request, options)

getConnectionProfile(request?: protos.google.cloud.datastream.v1.IGetConnectionProfileRequest, options?: CallOptions): Promise<[
        protos.google.cloud.datastream.v1.IConnectionProfile,
        (protos.google.cloud.datastream.v1.IGetConnectionProfileRequest | undefined),
        {} | undefined
    ]>;

Use this method to get details about a connection profile.

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

Returns
Type	Description
`Promise<[ protos.google.cloud.datastream.v1.IConnectionProfile, (protos.google.cloud.datastream.v1.IGetConnectionProfileRequest \| undefined), {} \| undefined ]>`	{Promise} - The promise which resolves to an array. The first element of the array is an object representing ConnectionProfile. 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 connection profile resource to get.
   */
  // const name = 'abc123'

  // Imports the Datastream library
  const {DatastreamClient} = require('@google-cloud/datastream').v1;

  // Instantiates a client
  const datastreamClient = new DatastreamClient();

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

    // Run request
    const response = await datastreamClient.getConnectionProfile(request);
    console.log(response);
  }

  callGetConnectionProfile();

getConnectionProfile(request, options, callback)

getConnectionProfile(request: protos.google.cloud.datastream.v1.IGetConnectionProfileRequest, options: CallOptions, callback: Callback<protos.google.cloud.datastream.v1.IConnectionProfile, protos.google.cloud.datastream.v1.IGetConnectionProfileRequest | null | undefined, {} | null | undefined>): void;

Parameters
Name	Description
`request`	`IGetConnectionProfileRequest`
`options`	`CallOptions`
`callback`	`Callback<protos.google.cloud.datastream.v1.IConnectionProfile, protos.google.cloud.datastream.v1.IGetConnectionProfileRequest \| null \| undefined, {} \| null \| undefined>`

Returns
Type	Description
`void`

getConnectionProfile(request, callback)

getConnectionProfile(request: protos.google.cloud.datastream.v1.IGetConnectionProfileRequest, callback: Callback<protos.google.cloud.datastream.v1.IConnectionProfile, protos.google.cloud.datastream.v1.IGetConnectionProfileRequest | null | undefined, {} | null | undefined>): void;

Parameters
Name	Description
`request`	`IGetConnectionProfileRequest`
`callback`	`Callback<protos.google.cloud.datastream.v1.IConnectionProfile, protos.google.cloud.datastream.v1.IGetConnectionProfileRequest \| null \| undefined, {} \| null \| undefined>`

Returns
Type	Description
`void`

getIamPolicy(request, options, callback)

getIamPolicy(request: IamProtos.google.iam.v1.GetIamPolicyRequest, options?: gax.CallOptions | Callback<IamProtos.google.iam.v1.Policy, IamProtos.google.iam.v1.GetIamPolicyRequest | null | undefined, {} | null | undefined>, callback?: Callback<IamProtos.google.iam.v1.Policy, IamProtos.google.iam.v1.GetIamPolicyRequest | null | undefined, {} | null | undefined>): Promise<[IamProtos.google.iam.v1.Policy]>;

Gets the access control policy for a resource. Returns an empty policy if the resource exists and does not have a policy set.

Parameters
Name	Description
`request`	`IamProtos.google.iam.v1.GetIamPolicyRequest` The request object that will be sent.
`options`	`CallOptions \| Callback<google.iam.v1.Policy, google.iam.v1.GetIamPolicyRequest \| null \| undefined, {} \| 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<google.iam.v1.Policy, google.iam.v1.GetIamPolicyRequest \| null \| undefined, {} \| 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 .

Returns
Type	Description
`Promise<[google.iam.v1.Policy]>`	{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.

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)

getPrivateConnection(request, options)

getPrivateConnection(request?: protos.google.cloud.datastream.v1.IGetPrivateConnectionRequest, options?: CallOptions): Promise<[
        protos.google.cloud.datastream.v1.IPrivateConnection,
        (protos.google.cloud.datastream.v1.IGetPrivateConnectionRequest | undefined),
        {} | undefined
    ]>;

Use this method to get details about a private connectivity configuration.

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

Returns
Type	Description
`Promise<[ protos.google.cloud.datastream.v1.IPrivateConnection, (protos.google.cloud.datastream.v1.IGetPrivateConnectionRequest \| 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  private connectivity configuration to get.
   */
  // const name = 'abc123'

  // Imports the Datastream library
  const {DatastreamClient} = require('@google-cloud/datastream').v1;

  // Instantiates a client
  const datastreamClient = new DatastreamClient();

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

    // Run request
    const response = await datastreamClient.getPrivateConnection(request);
    console.log(response);
  }

  callGetPrivateConnection();

getPrivateConnection(request, options, callback)

getPrivateConnection(request: protos.google.cloud.datastream.v1.IGetPrivateConnectionRequest, options: CallOptions, callback: Callback<protos.google.cloud.datastream.v1.IPrivateConnection, protos.google.cloud.datastream.v1.IGetPrivateConnectionRequest | null | undefined, {} | null | undefined>): void;

Parameters
Name	Description
`request`	`IGetPrivateConnectionRequest`
`options`	`CallOptions`
`callback`	`Callback<protos.google.cloud.datastream.v1.IPrivateConnection, protos.google.cloud.datastream.v1.IGetPrivateConnectionRequest \| null \| undefined, {} \| null \| undefined>`

Returns
Type	Description
`void`

getPrivateConnection(request, callback)

getPrivateConnection(request: protos.google.cloud.datastream.v1.IGetPrivateConnectionRequest, callback: Callback<protos.google.cloud.datastream.v1.IPrivateConnection, protos.google.cloud.datastream.v1.IGetPrivateConnectionRequest | null | undefined, {} | null | undefined>): void;

Parameters
Name	Description
`request`	`IGetPrivateConnectionRequest`
`callback`	`Callback<protos.google.cloud.datastream.v1.IPrivateConnection, protos.google.cloud.datastream.v1.IGetPrivateConnectionRequest \| 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>`