Class v1beta.DataAgentServiceClient (0.7.0)

Service describing handlers for resources. v1beta

Package

@google-cloud/geminidataanalytics

Constructors

(constructor)(opts, gaxInstance)

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

Construct an instance of DataAgentServiceClient.

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

dataAgentServiceStub

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

descriptors

descriptors: Descriptors;

innerApiCalls

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

locationsClient

locationsClient: LocationsClient;

operationsClient

operationsClient: gax.OperationsClient;

pathTemplates

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

port

static get port(): number;

The port for this API service.

scopes

static get scopes(): string[];

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

servicePath

static get servicePath(): string;

The DNS address for this API service.

universeDomain

get universeDomain(): string;

warn

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

Methods

cancelOperation(request, optionsOrCallback, callback)

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

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

Parameters
Name Description
request CancelOperationRequest

The request object that will be sent.
optionsOrCallback CallOptions | Callback<protos.google.longrunning.CancelOperationRequest, protos.google.protobuf.Empty, {} | undefined | null>
callback Callback<protos.google.longrunning.CancelOperationRequest, protos.google.protobuf.Empty, {} | undefined | null>

The function which will be called with the result of the API call. {Promise} - The promise which resolves when API call finishes. The promise has a method named "cancel" which cancels the ongoing API call.
Returns
Type Description
Promise<protos.google.protobuf.Empty>
Example 

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

checkCreateDataAgentProgress(name)

checkCreateDataAgentProgress(name: string): Promise<LROperation<protos.google.cloud.geminidataanalytics.v1beta.DataAgent, protos.google.cloud.geminidataanalytics.v1beta.OperationMetadata>>;

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

Parameter
Name Description
name string

The operation name that will be passed.
Returns
Type Description
Promise<LROperation<protos.google.cloud.geminidataanalytics.v1beta.DataAgent, protos.google.cloud.geminidataanalytics.v1beta.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'
  /**
   *  Optional. Id of the requesting object. Must be unique within the parent.
   *  The allowed format is: `^[a-z]([a-z0-9-]{0,61}[a-z0-9])?$`.
   *  If not provided, the server will auto-generate a value for the id.
   */
  // const dataAgentId = 'abc123'
  /**
   *  Required. The resource being created.
   */
  // const dataAgent = {}
  /**
   *  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 Geminidataanalytics library
  const {DataAgentServiceClient} = require('@google-cloud/geminidataanalytics').v1beta;

  // Instantiates a client
  const geminidataanalyticsClient = new DataAgentServiceClient();

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

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

  callCreateDataAgent();

checkDeleteDataAgentProgress(name)

checkDeleteDataAgentProgress(name: string): Promise<LROperation<protos.google.protobuf.Empty, protos.google.cloud.geminidataanalytics.v1beta.OperationMetadata>>;

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

Parameter
Name Description
name string

The operation name that will be passed.
Returns
Type Description
Promise<LROperation<protos.google.protobuf.Empty, protos.google.cloud.geminidataanalytics.v1beta.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 Geminidataanalytics library
  const {DataAgentServiceClient} = require('@google-cloud/geminidataanalytics').v1beta;

  // Instantiates a client
  const geminidataanalyticsClient = new DataAgentServiceClient();

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

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

  callDeleteDataAgent();

checkUpdateDataAgentProgress(name)

checkUpdateDataAgentProgress(name: string): Promise<LROperation<protos.google.cloud.geminidataanalytics.v1beta.DataAgent, protos.google.cloud.geminidataanalytics.v1beta.OperationMetadata>>;

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

Parameter
Name Description
name string

The operation name that will be passed.
Returns
Type Description
Promise<LROperation<protos.google.cloud.geminidataanalytics.v1beta.DataAgent, protos.google.cloud.geminidataanalytics.v1beta.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
   *  DataAgent 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 with non-default values
   *  present in the request will be overwritten. If a wildcard mask is provided,
   *  all fields will be overwritten.
   */
  // const updateMask = {}
  /**
   *  Required. The resource being updated.
   */
  // const dataAgent = {}
  /**
   *  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 Geminidataanalytics library
  const {DataAgentServiceClient} = require('@google-cloud/geminidataanalytics').v1beta;

  // Instantiates a client
  const geminidataanalyticsClient = new DataAgentServiceClient();

  async function callUpdateDataAgent() {
    // Construct request
    const request = {
      dataAgent,
    };

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

  callUpdateDataAgent();

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.

conversationPath(project, location, conversation)

conversationPath(project: string, location: string, conversation: string): string;

Return a fully-qualified conversation resource name string.

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

{string} Resource name string.

createDataAgent(request, options)

createDataAgent(request?: protos.google.cloud.geminidataanalytics.v1beta.ICreateDataAgentRequest, options?: CallOptions): Promise<[
        LROperation<protos.google.cloud.geminidataanalytics.v1beta.IDataAgent, protos.google.cloud.geminidataanalytics.v1beta.IOperationMetadata>,
        protos.google.longrunning.IOperation | undefined,
        {} | undefined
    ]>;

Creates a new DataAgent in a given project and location.

Parameters
Name Description
request ICreateDataAgentRequest

The request object that will be sent.
options CallOptions

Call options. See CallOptions for more details.
Returns
Type Description
Promise<[ LROperation<protos.google.cloud.geminidataanalytics.v1beta.IDataAgent, protos.google.cloud.geminidataanalytics.v1beta.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'
  /**
   *  Optional. Id of the requesting object. Must be unique within the parent.
   *  The allowed format is: `^[a-z]([a-z0-9-]{0,61}[a-z0-9])?$`.
   *  If not provided, the server will auto-generate a value for the id.
   */
  // const dataAgentId = 'abc123'
  /**
   *  Required. The resource being created.
   */
  // const dataAgent = {}
  /**
   *  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 Geminidataanalytics library
  const {DataAgentServiceClient} = require('@google-cloud/geminidataanalytics').v1beta;

  // Instantiates a client
  const geminidataanalyticsClient = new DataAgentServiceClient();

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

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

  callCreateDataAgent();

createDataAgent(request, options, callback)

createDataAgent(request: protos.google.cloud.geminidataanalytics.v1beta.ICreateDataAgentRequest, options: CallOptions, callback: Callback<LROperation<protos.google.cloud.geminidataanalytics.v1beta.IDataAgent, protos.google.cloud.geminidataanalytics.v1beta.IOperationMetadata>, protos.google.longrunning.IOperation | null | undefined, {} | null | undefined>): void;
Parameters
Name Description
request ICreateDataAgentRequest
options CallOptions
callback Callback<LROperation<protos.google.cloud.geminidataanalytics.v1beta.IDataAgent, protos.google.cloud.geminidataanalytics.v1beta.IOperationMetadata>, protos.google.longrunning.IOperation | null | undefined, {} | null | undefined>
Returns
Type Description
void

createDataAgent(request, callback)

createDataAgent(request: protos.google.cloud.geminidataanalytics.v1beta.ICreateDataAgentRequest, callback: Callback<LROperation<protos.google.cloud.geminidataanalytics.v1beta.IDataAgent, protos.google.cloud.geminidataanalytics.v1beta.IOperationMetadata>, protos.google.longrunning.IOperation | null | undefined, {} | null | undefined>): void;
Parameters
Name Description
request ICreateDataAgentRequest
callback Callback<LROperation<protos.google.cloud.geminidataanalytics.v1beta.IDataAgent, protos.google.cloud.geminidataanalytics.v1beta.IOperationMetadata>, protos.google.longrunning.IOperation | null | undefined, {} | null | undefined>
Returns
Type Description
void

createDataAgentSync(request, options)

createDataAgentSync(request?: protos.google.cloud.geminidataanalytics.v1beta.ICreateDataAgentRequest, options?: CallOptions): Promise<[
        protos.google.cloud.geminidataanalytics.v1beta.IDataAgent,
        protos.google.cloud.geminidataanalytics.v1beta.ICreateDataAgentRequest | undefined,
        {} | undefined
    ]>;

Creates a new DataAgent in a given project and location synchronously.

Parameters
Name Description
request ICreateDataAgentRequest

The request object that will be sent.
options CallOptions

Call options. See CallOptions for more details.
Returns
Type Description
Promise<[ protos.google.cloud.geminidataanalytics.v1beta.IDataAgent, protos.google.cloud.geminidataanalytics.v1beta.ICreateDataAgentRequest | undefined, {} | undefined ]>

{Promise} - The promise which resolves to an array. The first element of the array is an object representing DataAgent. 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'
  /**
   *  Optional. Id of the requesting object. Must be unique within the parent.
   *  The allowed format is: `^[a-z]([a-z0-9-]{0,61}[a-z0-9])?$`.
   *  If not provided, the server will auto-generate a value for the id.
   */
  // const dataAgentId = 'abc123'
  /**
   *  Required. The resource being created.
   */
  // const dataAgent = {}
  /**
   *  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 Geminidataanalytics library
  const {DataAgentServiceClient} = require('@google-cloud/geminidataanalytics').v1beta;

  // Instantiates a client
  const geminidataanalyticsClient = new DataAgentServiceClient();

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

    // Run request
    const response = await geminidataanalyticsClient.createDataAgentSync(request);
    console.log(response);
  }

  callCreateDataAgentSync();

createDataAgentSync(request, options, callback)

createDataAgentSync(request: protos.google.cloud.geminidataanalytics.v1beta.ICreateDataAgentRequest, options: CallOptions, callback: Callback<protos.google.cloud.geminidataanalytics.v1beta.IDataAgent, protos.google.cloud.geminidataanalytics.v1beta.ICreateDataAgentRequest | null | undefined, {} | null | undefined>): void;
Parameters
Name Description
request ICreateDataAgentRequest
options CallOptions
callback Callback<protos.google.cloud.geminidataanalytics.v1beta.IDataAgent, protos.google.cloud.geminidataanalytics.v1beta.ICreateDataAgentRequest | null | undefined, {} | null | undefined>
Returns
Type Description
void

createDataAgentSync(request, callback)

createDataAgentSync(request: protos.google.cloud.geminidataanalytics.v1beta.ICreateDataAgentRequest, callback: Callback<protos.google.cloud.geminidataanalytics.v1beta.IDataAgent, protos.google.cloud.geminidataanalytics.v1beta.ICreateDataAgentRequest | null | undefined, {} | null | undefined>): void;
Parameters
Name Description
request ICreateDataAgentRequest
callback Callback<protos.google.cloud.geminidataanalytics.v1beta.IDataAgent, protos.google.cloud.geminidataanalytics.v1beta.ICreateDataAgentRequest | null | undefined, {} | null | undefined>
Returns
Type Description
void

dataAgentPath(project, location, dataAgent)

dataAgentPath(project: string, location: string, dataAgent: string): string;

Return a fully-qualified dataAgent resource name string.

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

{string} Resource name string.

deleteDataAgent(request, options)

deleteDataAgent(request?: protos.google.cloud.geminidataanalytics.v1beta.IDeleteDataAgentRequest, options?: CallOptions): Promise<[
        LROperation<protos.google.protobuf.IEmpty, protos.google.cloud.geminidataanalytics.v1beta.IOperationMetadata>,
        protos.google.longrunning.IOperation | undefined,
        {} | undefined
    ]>;

Deletes a single DataAgent.

Parameters
Name Description
request IDeleteDataAgentRequest

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.geminidataanalytics.v1beta.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 Geminidataanalytics library
  const {DataAgentServiceClient} = require('@google-cloud/geminidataanalytics').v1beta;

  // Instantiates a client
  const geminidataanalyticsClient = new DataAgentServiceClient();

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

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

  callDeleteDataAgent();

deleteDataAgent(request, options, callback)

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

deleteDataAgent(request, callback)

deleteDataAgent(request: protos.google.cloud.geminidataanalytics.v1beta.IDeleteDataAgentRequest, callback: Callback<LROperation<protos.google.protobuf.IEmpty, protos.google.cloud.geminidataanalytics.v1beta.IOperationMetadata>, protos.google.longrunning.IOperation | null | undefined, {} | null | undefined>): void;
Parameters
Name Description
request IDeleteDataAgentRequest
callback Callback<LROperation<protos.google.protobuf.IEmpty, protos.google.cloud.geminidataanalytics.v1beta.IOperationMetadata>, protos.google.longrunning.IOperation | null | undefined, {} | null | undefined>
Returns
Type Description
void

deleteDataAgentSync(request, options)

deleteDataAgentSync(request?: protos.google.cloud.geminidataanalytics.v1beta.IDeleteDataAgentRequest, options?: CallOptions): Promise<[
        protos.google.protobuf.IEmpty,
        protos.google.cloud.geminidataanalytics.v1beta.IDeleteDataAgentRequest | undefined,
        {} | undefined
    ]>;

Deletes a single DataAgent synchronously.

Parameters
Name Description
request IDeleteDataAgentRequest

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.geminidataanalytics.v1beta.IDeleteDataAgentRequest | 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. 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 Geminidataanalytics library
  const {DataAgentServiceClient} = require('@google-cloud/geminidataanalytics').v1beta;

  // Instantiates a client
  const geminidataanalyticsClient = new DataAgentServiceClient();

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

    // Run request
    const response = await geminidataanalyticsClient.deleteDataAgentSync(request);
    console.log(response);
  }

  callDeleteDataAgentSync();

deleteDataAgentSync(request, options, callback)

deleteDataAgentSync(request: protos.google.cloud.geminidataanalytics.v1beta.IDeleteDataAgentRequest, options: CallOptions, callback: Callback<protos.google.protobuf.IEmpty, protos.google.cloud.geminidataanalytics.v1beta.IDeleteDataAgentRequest | null | undefined, {} | null | undefined>): void;
Parameters
Name Description
request IDeleteDataAgentRequest
options CallOptions
callback Callback<protos.google.protobuf.IEmpty, protos.google.cloud.geminidataanalytics.v1beta.IDeleteDataAgentRequest | null | undefined, {} | null | undefined>
Returns
Type Description
void

deleteDataAgentSync(request, callback)

deleteDataAgentSync(request: protos.google.cloud.geminidataanalytics.v1beta.IDeleteDataAgentRequest, callback: Callback<protos.google.protobuf.IEmpty, protos.google.cloud.geminidataanalytics.v1beta.IDeleteDataAgentRequest | null | undefined, {} | null | undefined>): void;
Parameters
Name Description
request IDeleteDataAgentRequest
callback Callback<protos.google.protobuf.IEmpty, protos.google.cloud.geminidataanalytics.v1beta.IDeleteDataAgentRequest | null | undefined, {} | null | undefined>
Returns
Type Description
void

deleteOperation(request, optionsOrCallback, callback)

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

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

Parameters
Name Description
request DeleteOperationRequest

The request object that will be sent.
optionsOrCallback CallOptions | Callback<protos.google.protobuf.Empty, protos.google.longrunning.DeleteOperationRequest, {} | null | undefined>
callback Callback<protos.google.protobuf.Empty, protos.google.longrunning.DeleteOperationRequest, {} | null | undefined>

The function which will be called with the result of the API call. {Promise} - The promise which resolves when API call finishes. The promise has a method named "cancel" which cancels the ongoing API call.
Returns
Type Description
Promise<protos.google.protobuf.Empty>
Example 

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

getDataAgent(request, options)

getDataAgent(request?: protos.google.cloud.geminidataanalytics.v1beta.IGetDataAgentRequest, options?: CallOptions): Promise<[
        protos.google.cloud.geminidataanalytics.v1beta.IDataAgent,
        protos.google.cloud.geminidataanalytics.v1beta.IGetDataAgentRequest | undefined,
        {} | undefined
    ]>;

Gets details of a single DataAgent.

Parameters
Name Description
request IGetDataAgentRequest

The request object that will be sent.
options CallOptions

Call options. See CallOptions for more details.
Returns
Type Description
Promise<[ protos.google.cloud.geminidataanalytics.v1beta.IDataAgent, protos.google.cloud.geminidataanalytics.v1beta.IGetDataAgentRequest | undefined, {} | undefined ]>

{Promise} - The promise which resolves to an array. The first element of the array is an object representing DataAgent. 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 Geminidataanalytics library
  const {DataAgentServiceClient} = require('@google-cloud/geminidataanalytics').v1beta;

  // Instantiates a client
  const geminidataanalyticsClient = new DataAgentServiceClient();

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

    // Run request
    const response = await geminidataanalyticsClient.getDataAgent(request);
    console.log(response);
  }

  callGetDataAgent();

getDataAgent(request, options, callback)

getDataAgent(request: protos.google.cloud.geminidataanalytics.v1beta.IGetDataAgentRequest, options: CallOptions, callback: Callback<protos.google.cloud.geminidataanalytics.v1beta.IDataAgent, protos.google.cloud.geminidataanalytics.v1beta.IGetDataAgentRequest | null | undefined, {} | null | undefined>): void;
Parameters
Name Description
request IGetDataAgentRequest
options CallOptions
callback Callback<protos.google.cloud.geminidataanalytics.v1beta.IDataAgent, protos.google.cloud.geminidataanalytics.v1beta.IGetDataAgentRequest | null | undefined, {} | null | undefined>
Returns
Type Description
void

getDataAgent(request, callback)

getDataAgent(request: protos.google.cloud.geminidataanalytics.v1beta.IGetDataAgentRequest, callback: Callback<protos.google.cloud.geminidataanalytics.v1beta.IDataAgent, protos.google.cloud.geminidataanalytics.v1beta.IGetDataAgentRequest | null | undefined, {} | null | undefined>): void;
Parameters
Name Description
request IGetDataAgentRequest
callback Callback<protos.google.cloud.geminidataanalytics.v1beta.IDataAgent, protos.google.cloud.geminidataanalytics.v1beta.IGetDataAgentRequest | null | undefined, {} | null | undefined>
Returns
Type Description
void

getIamPolicy(request, options)

getIamPolicy(request?: protos.google.iam.v1.IGetIamPolicyRequest, options?: CallOptions): Promise<[
        protos.google.iam.v1.IPolicy,
        protos.google.iam.v1.IGetIamPolicyRequest | undefined,
        {} | undefined
    ]>;

Gets the IAM policy for DataAgent

Parameters
Name Description
request IGetIamPolicyRequest

The request object that will be sent.
options CallOptions

Call options. See CallOptions for more details.
Returns
Type Description
Promise<[ protos.google.iam.v1.IPolicy, protos.google.iam.v1.IGetIamPolicyRequest | undefined, {} | undefined ]>

{Promise} - The promise which resolves to an array. The first element of the array is an object representing Policy. 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 for which the policy is being requested.
   *  See the operation documentation for the appropriate value for this field.
   */
  // const resource = 'abc123'
  /**
   *  OPTIONAL: A `GetPolicyOptions` object for specifying options to
   *  `GetIamPolicy`.
   */
  // const options = {}

  // Imports the Geminidataanalytics library
  const {DataAgentServiceClient} = require('@google-cloud/geminidataanalytics').v1beta;

  // Instantiates a client
  const geminidataanalyticsClient = new DataAgentServiceClient();

  async function callGetIamPolicy() {
    // Construct request
    const request = {
      resource,
    };

    // Run request
    const response = await geminidataanalyticsClient.getIamPolicy(request);
    console.log(response);
  }

  callGetIamPolicy();

getIamPolicy(request, options, callback)

getIamPolicy(request: protos.google.iam.v1.IGetIamPolicyRequest, options: CallOptions, callback: Callback<protos.google.iam.v1.IPolicy, protos.google.iam.v1.IGetIamPolicyRequest | null | undefined, {} | null | undefined>): void;
Parameters
Name Description
request IGetIamPolicyRequest
options CallOptions
callback Callback<protos.google.iam.v1.IPolicy, protos.google.iam.v1.IGetIamPolicyRequest | null | undefined, {} | null | undefined>
Returns
Type Description
void

getIamPolicy(request, callback)

getIamPolicy(request: protos.google.iam.v1.IGetIamPolicyRequest, callback: Callback<protos.google.iam.v1.IPolicy, protos.google.iam.v1.IGetIamPolicyRequest | null | undefined, {} | null | undefined>): void;
Parameters
Name Description
request IGetIamPolicyRequest
callback Callback<protos.google.iam.v1.IPolicy, protos.google.iam.v1.IGetIamPolicyRequest | null | undefined, {} | null | undefined>
Returns
Type Description
void

getLocation(request, options, callback)

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

Gets information about a location.

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

The request object that will be sent.
options CallOptions | Callback<google.cloud.location.ILocation, google.cloud.location.IGetLocationRequest | null | undefined, {} | null | undefined>

Call options. See CallOptions for more details.
callback Callback<google.cloud.location.ILocation, google.cloud.location.IGetLocationRequest | null | undefined, {} | null | undefined>
Returns
Type Description
Promise<google.cloud.location.ILocation>

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

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

getOperation(request, optionsOrCallback, callback)

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

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

Parameters
Name Description
request GetOperationRequest

The request object that will be sent.
optionsOrCallback CallOptions | Callback<protos.google.longrunning.Operation, protos.google.longrunning.GetOperationRequest, {} | null | undefined>
callback Callback<protos.google.longrunning.Operation, protos.google.longrunning.GetOperationRequest, {} | null | undefined>

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

The second parameter to the callback is an object representing . {Promise} - The promise which resolves to an array. The first element of the array is an object representing . The promise has a method named "cancel" which cancels the ongoing API call.
Returns
Type Description
Promise<[protos.google.longrunning.Operation]>
Example 

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

getProjectId()

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

getProjectId(callback)

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

initialize()

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

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

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

Returns
Type Description
Promise<{ [name: string]: Function; }>

{Promise} A promise that resolves to an authenticated service stub.

listAccessibleDataAgents(request, options)

listAccessibleDataAgents(request?: protos.google.cloud.geminidataanalytics.v1beta.IListAccessibleDataAgentsRequest, options?: CallOptions): Promise<[
        protos.google.cloud.geminidataanalytics.v1beta.IDataAgent[],
        protos.google.cloud.geminidataanalytics.v1beta.IListAccessibleDataAgentsRequest | null,
        protos.google.cloud.geminidataanalytics.v1beta.IListAccessibleDataAgentsResponse
    ]>;

Lists DataAgents that are accessible to the caller in a given project and location.

Parameters
Name Description
request IListAccessibleDataAgentsRequest

The request object that will be sent.
options CallOptions

Call options. See CallOptions for more details.
Returns
Type Description
Promise<[ protos.google.cloud.geminidataanalytics.v1beta.IDataAgent[], protos.google.cloud.geminidataanalytics.v1beta.IListAccessibleDataAgentsRequest | null, protos.google.cloud.geminidataanalytics.v1beta.IListAccessibleDataAgentsResponse ]>

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

listAccessibleDataAgents(request, options, callback)

listAccessibleDataAgents(request: protos.google.cloud.geminidataanalytics.v1beta.IListAccessibleDataAgentsRequest, options: CallOptions, callback: PaginationCallback<protos.google.cloud.geminidataanalytics.v1beta.IListAccessibleDataAgentsRequest, protos.google.cloud.geminidataanalytics.v1beta.IListAccessibleDataAgentsResponse | null | undefined, protos.google.cloud.geminidataanalytics.v1beta.IDataAgent>): void;
Parameters
Name Description
request IListAccessibleDataAgentsRequest
options CallOptions
callback PaginationCallback<protos.google.cloud.geminidataanalytics.v1beta.IListAccessibleDataAgentsRequest, protos.google.cloud.geminidataanalytics.v1beta.IListAccessibleDataAgentsResponse | null | undefined, protos.google.cloud.geminidataanalytics.v1beta.IDataAgent>
Returns
Type Description
void

listAccessibleDataAgents(request, callback)

listAccessibleDataAgents(request: protos.google.cloud.geminidataanalytics.v1beta.IListAccessibleDataAgentsRequest, callback: PaginationCallback<protos.google.cloud.geminidataanalytics.v1beta.IListAccessibleDataAgentsRequest, protos.google.cloud.geminidataanalytics.v1beta.IListAccessibleDataAgentsResponse | null | undefined, protos.google.cloud.geminidataanalytics.v1beta.IDataAgent>): void;
Parameters
Name Description
request IListAccessibleDataAgentsRequest
callback PaginationCallback<protos.google.cloud.geminidataanalytics.v1beta.IListAccessibleDataAgentsRequest, protos.google.cloud.geminidataanalytics.v1beta.IListAccessibleDataAgentsResponse | null | undefined, protos.google.cloud.geminidataanalytics.v1beta.IDataAgent>
Returns
Type Description
void

listAccessibleDataAgentsAsync(request, options)

listAccessibleDataAgentsAsync(request?: protos.google.cloud.geminidataanalytics.v1beta.IListAccessibleDataAgentsRequest, options?: CallOptions): AsyncIterable<protos.google.cloud.geminidataanalytics.v1beta.IDataAgent>;

Equivalent to listAccessibleDataAgents, but returns an iterable object.

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

Parameters
Name Description
request IListAccessibleDataAgentsRequest

The request object that will be sent.
options CallOptions

Call options. See CallOptions for more details.
Returns
Type Description
AsyncIterable<protos.google.cloud.geminidataanalytics.v1beta.IDataAgent>

{Object} An iterable Object that allows async iteration. When you iterate the returned iterable, each element will be an object representing DataAgent. 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 ListAccessibleDataAgentsRequest.
   */
  // const parent = 'abc123'
  /**
   *  Optional. Server may return fewer items than requested.
   *  If unspecified, server will pick an appropriate default.
   */
  // const pageSize = 1234
  /**
   *  Optional. A page token, received from a previous `ListAccessibleDataAgents`
   *  call. Provide this to retrieve the subsequent page.
   *  When paginating, all other parameters provided to
   *  `ListAccessibleDataAgents` must match the call that provided the page
   *  token. The service may return fewer than this value.
   */
  // const pageToken = 'abc123'
  /**
   *  Optional. Filtering results. See AIP-160 (https://google.aip.dev/160) for
   *  syntax.
   */
  // const filter = 'abc123'
  /**
   *  Optional. User specification for how to order the results.
   */
  // const orderBy = 'abc123'
  /**
   *  Optional. If true, the list results will include soft-deleted DataAgents.
   *  Defaults to false.
   */
  // const showDeleted = true
  /**
   *  Optional. Filter for the creator of the agent.
   */
  // const creatorFilter = {}

  // Imports the Geminidataanalytics library
  const {DataAgentServiceClient} = require('@google-cloud/geminidataanalytics').v1beta;

  // Instantiates a client
  const geminidataanalyticsClient = new DataAgentServiceClient();

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

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

  callListAccessibleDataAgents();

listAccessibleDataAgentsStream(request, options)

listAccessibleDataAgentsStream(request?: protos.google.cloud.geminidataanalytics.v1beta.IListAccessibleDataAgentsRequest, options?: CallOptions): Transform;

Equivalent to listAccessibleDataAgents, but returns a NodeJS Stream object.

Parameters
Name Description
request IListAccessibleDataAgentsRequest

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

listDataAgents(request, options)

listDataAgents(request?: protos.google.cloud.geminidataanalytics.v1beta.IListDataAgentsRequest, options?: CallOptions): Promise<[
        protos.google.cloud.geminidataanalytics.v1beta.IDataAgent[],
        protos.google.cloud.geminidataanalytics.v1beta.IListDataAgentsRequest | null,
        protos.google.cloud.geminidataanalytics.v1beta.IListDataAgentsResponse
    ]>;

Lists DataAgents in a given project and location.

Parameters
Name Description
request IListDataAgentsRequest

The request object that will be sent.
options CallOptions

Call options. See CallOptions for more details.
Returns
Type Description
Promise<[ protos.google.cloud.geminidataanalytics.v1beta.IDataAgent[], protos.google.cloud.geminidataanalytics.v1beta.IListDataAgentsRequest | null, protos.google.cloud.geminidataanalytics.v1beta.IListDataAgentsResponse ]>

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

listDataAgents(request, options, callback)

listDataAgents(request: protos.google.cloud.geminidataanalytics.v1beta.IListDataAgentsRequest, options: CallOptions, callback: PaginationCallback<protos.google.cloud.geminidataanalytics.v1beta.IListDataAgentsRequest, protos.google.cloud.geminidataanalytics.v1beta.IListDataAgentsResponse | null | undefined, protos.google.cloud.geminidataanalytics.v1beta.IDataAgent>): void;
Parameters
Name Description
request IListDataAgentsRequest
options CallOptions
callback PaginationCallback<protos.google.cloud.geminidataanalytics.v1beta.IListDataAgentsRequest, protos.google.cloud.geminidataanalytics.v1beta.IListDataAgentsResponse | null | undefined, protos.google.cloud.geminidataanalytics.v1beta.IDataAgent>
Returns
Type Description
void

listDataAgents(request, callback)

listDataAgents(request: protos.google.cloud.geminidataanalytics.v1beta.IListDataAgentsRequest, callback: PaginationCallback<protos.google.cloud.geminidataanalytics.v1beta.IListDataAgentsRequest, protos.google.cloud.geminidataanalytics.v1beta.IListDataAgentsResponse | null | undefined, protos.google.cloud.geminidataanalytics.v1beta.IDataAgent>): void;
Parameters
Name Description
request IListDataAgentsRequest
callback PaginationCallback<protos.google.cloud.geminidataanalytics.v1beta.IListDataAgentsRequest, protos.google.cloud.geminidataanalytics.v1beta.IListDataAgentsResponse | null | undefined, protos.google.cloud.geminidataanalytics.v1beta.IDataAgent>
Returns
Type Description
void

listDataAgentsAsync(request, options)

listDataAgentsAsync(request?: protos.google.cloud.geminidataanalytics.v1beta.IListDataAgentsRequest, options?: CallOptions): AsyncIterable<protos.google.cloud.geminidataanalytics.v1beta.IDataAgent>;

Equivalent to listDataAgents, but returns an iterable object.

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

Parameters
Name Description
request IListDataAgentsRequest

The request object that will be sent.
options CallOptions

Call options. See CallOptions for more details.
Returns
Type Description
AsyncIterable<protos.google.cloud.geminidataanalytics.v1beta.IDataAgent>

{Object} An iterable Object that allows async iteration. When you iterate the returned iterable, each element will be an object representing DataAgent. 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 ListDataAgentsRequest.
   */
  // const parent = 'abc123'
  /**
   *  Optional. Server may return fewer items than requested.
   *  If unspecified, server will pick an appropriate default.
   */
  // const pageSize = 1234
  /**
   *  Optional. A page token, received from a previous `ListDataAgents` call.
   *  Provide this to retrieve the subsequent page.
   *  When paginating, all other parameters provided to `ListDataAgents` must
   *  match the call that provided the page token. The service may return fewer
   *  than this value.
   */
  // const pageToken = 'abc123'
  /**
   *  Optional. Filtering results. See AIP-160 (https://google.aip.dev/160) for
   *  syntax.
   */
  // const filter = 'abc123'
  /**
   *  Optional. User specification for how to order the results.
   */
  // const orderBy = 'abc123'
  /**
   *  Optional. If true, the list results will include soft-deleted DataAgents.
   *  Defaults to false.
   */
  // const showDeleted = true

  // Imports the Geminidataanalytics library
  const {DataAgentServiceClient} = require('@google-cloud/geminidataanalytics').v1beta;

  // Instantiates a client
  const geminidataanalyticsClient = new DataAgentServiceClient();

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

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

  callListDataAgents();

listDataAgentsStream(request, options)

listDataAgentsStream(request?: protos.google.cloud.geminidataanalytics.v1beta.IListDataAgentsRequest, options?: CallOptions): Transform;

Equivalent to listDataAgents, but returns a NodeJS Stream object.

Parameters
Name Description
request IListDataAgentsRequest

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

listLocationsAsync(request, options)

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

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

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

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

The request object that will be sent.
options CallOptions

Call options. See CallOptions for more details.
Returns
Type Description
AsyncIterable<google.cloud.location.ILocation>

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

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

listOperationsAsync(request, options)

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

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

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

Parameters
Name Description
request ListOperationsRequest

The request object that will be sent.
options CallOptions

Optional parameters. You can override the default settings for this call, e.g, timeout, retries, paginations, etc. See gax.CallOptions for the details.
Returns
Type Description
AsyncIterable<protos.google.longrunning.IOperation>

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

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

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.

matchConversationFromConversationName(conversationName)

matchConversationFromConversationName(conversationName: string): string | number;

Parse the conversation from Conversation resource.

Parameter
Name Description
conversationName string

A fully-qualified path representing Conversation resource.
Returns
Type Description
string | number

{string} A string representing the conversation.

matchDataAgentFromDataAgentName(dataAgentName)

matchDataAgentFromDataAgentName(dataAgentName: string): string | number;

Parse the data_agent from DataAgent resource.

Parameter
Name Description
dataAgentName string

A fully-qualified path representing DataAgent resource.
Returns
Type Description
string | number

{string} A string representing the data_agent.

matchLocationFromConversationName(conversationName)

matchLocationFromConversationName(conversationName: string): string | number;

Parse the location from Conversation resource.

Parameter
Name Description
conversationName string

A fully-qualified path representing Conversation resource.
Returns
Type Description
string | number

{string} A string representing the location.

matchLocationFromDataAgentName(dataAgentName)

matchLocationFromDataAgentName(dataAgentName: string): string | number;

Parse the location from DataAgent resource.

Parameter
Name Description
dataAgentName string

A fully-qualified path representing DataAgent 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.

matchProjectFromConversationName(conversationName)

matchProjectFromConversationName(conversationName: string): string | number;

Parse the project from Conversation resource.

Parameter
Name Description
conversationName string

A fully-qualified path representing Conversation resource.
Returns
Type Description
string | number

{string} A string representing the project.

matchProjectFromDataAgentName(dataAgentName)

matchProjectFromDataAgentName(dataAgentName: string): string | number;

Parse the project from DataAgent resource.

Parameter
Name Description
dataAgentName string

A fully-qualified path representing DataAgent 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.

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.

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.

setIamPolicy(request, options)

setIamPolicy(request?: protos.google.iam.v1.ISetIamPolicyRequest, options?: CallOptions): Promise<[
        protos.google.iam.v1.IPolicy,
        protos.google.iam.v1.ISetIamPolicyRequest | undefined,
        {} | undefined
    ]>;

Sets the IAM policy for a DataAgent.

Parameters
Name Description
request ISetIamPolicyRequest

The request object that will be sent.
options CallOptions

Call options. See CallOptions for more details.
Returns
Type Description
Promise<[ protos.google.iam.v1.IPolicy, protos.google.iam.v1.ISetIamPolicyRequest | undefined, {} | undefined ]>

{Promise} - The promise which resolves to an array. The first element of the array is an object representing Policy. 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 for which the policy is being specified.
   *  See the operation documentation for the appropriate value for this field.
   */
  // const resource = 'abc123'
  /**
   *  REQUIRED: The complete policy to be applied to the `resource`. The size of
   *  the policy is limited to a few 10s of KB. An empty policy is a
   *  valid policy but certain Cloud Platform services (such as Projects)
   *  might reject them.
   */
  // const policy = {}
  /**
   *  OPTIONAL: A FieldMask specifying which fields of the policy to modify. Only
   *  the fields in the mask will be modified. If no mask is provided, the
   *  following default mask is used:
   *  `paths: "bindings, etag"`
   */
  // const updateMask = {}

  // Imports the Geminidataanalytics library
  const {DataAgentServiceClient} = require('@google-cloud/geminidataanalytics').v1beta;

  // Instantiates a client
  const geminidataanalyticsClient = new DataAgentServiceClient();

  async function callSetIamPolicy() {
    // Construct request
    const request = {
      resource,
      policy,
    };

    // Run request
    const response = await geminidataanalyticsClient.setIamPolicy(request);
    console.log(response);
  }

  callSetIamPolicy();

setIamPolicy(request, options, callback)

setIamPolicy(request: protos.google.iam.v1.ISetIamPolicyRequest, options: CallOptions, callback: Callback<protos.google.iam.v1.IPolicy, protos.google.iam.v1.ISetIamPolicyRequest | null | undefined, {} | null | undefined>): void;
Parameters
Name Description
request ISetIamPolicyRequest
options CallOptions
callback Callback<protos.google.iam.v1.IPolicy, protos.google.iam.v1.ISetIamPolicyRequest | null | undefined, {} | null | undefined>
Returns
Type Description
void

setIamPolicy(request, callback)

setIamPolicy(request: protos.google.iam.v1.ISetIamPolicyRequest, callback: Callback<protos.google.iam.v1.IPolicy, protos.google.iam.v1.ISetIamPolicyRequest | null | undefined, {} | null | undefined>): void;
Parameters
Name Description
request ISetIamPolicyRequest
callback Callback<protos.google.iam.v1.IPolicy, protos.google.iam.v1.ISetIamPolicyRequest | null | undefined, {} | null | undefined>
Returns
Type Description
void

updateDataAgent(request, options)

updateDataAgent(request?: protos.google.cloud.geminidataanalytics.v1beta.IUpdateDataAgentRequest, options?: CallOptions): Promise<[
        LROperation<protos.google.cloud.geminidataanalytics.v1beta.IDataAgent, protos.google.cloud.geminidataanalytics.v1beta.IOperationMetadata>,
        protos.google.longrunning.IOperation | undefined,
        {} | undefined
    ]>;

Updates the parameters of a single DataAgent.

Parameters
Name Description
request IUpdateDataAgentRequest

The request object that will be sent.
options CallOptions

Call options. See CallOptions for more details.
Returns
Type Description
Promise<[ LROperation<protos.google.cloud.geminidataanalytics.v1beta.IDataAgent, protos.google.cloud.geminidataanalytics.v1beta.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.
   */
  /**
   *  Optional. Field mask is used to specify the fields to be overwritten in the
   *  DataAgent 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 with non-default values
   *  present in the request will be overwritten. If a wildcard mask is provided,
   *  all fields will be overwritten.
   */
  // const updateMask = {}
  /**
   *  Required. The resource being updated.
   */
  // const dataAgent = {}
  /**
   *  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 Geminidataanalytics library
  const {DataAgentServiceClient} = require('@google-cloud/geminidataanalytics').v1beta;

  // Instantiates a client
  const geminidataanalyticsClient = new DataAgentServiceClient();

  async function callUpdateDataAgent() {
    // Construct request
    const request = {
      dataAgent,
    };

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

  callUpdateDataAgent();

updateDataAgent(request, options, callback)

updateDataAgent(request: protos.google.cloud.geminidataanalytics.v1beta.IUpdateDataAgentRequest, options: CallOptions, callback: Callback<LROperation<protos.google.cloud.geminidataanalytics.v1beta.IDataAgent, protos.google.cloud.geminidataanalytics.v1beta.IOperationMetadata>, protos.google.longrunning.IOperation | null | undefined, {} | null | undefined>): void;
Parameters
Name Description
request IUpdateDataAgentRequest
options CallOptions
callback Callback<LROperation<protos.google.cloud.geminidataanalytics.v1beta.IDataAgent, protos.google.cloud.geminidataanalytics.v1beta.IOperationMetadata>, protos.google.longrunning.IOperation | null | undefined, {} | null | undefined>
Returns
Type Description
void

updateDataAgent(request, callback)

updateDataAgent(request: protos.google.cloud.geminidataanalytics.v1beta.IUpdateDataAgentRequest, callback: Callback<LROperation<protos.google.cloud.geminidataanalytics.v1beta.IDataAgent, protos.google.cloud.geminidataanalytics.v1beta.IOperationMetadata>, protos.google.longrunning.IOperation | null | undefined, {} | null | undefined>): void;
Parameters
Name Description
request IUpdateDataAgentRequest
callback Callback<LROperation<protos.google.cloud.geminidataanalytics.v1beta.IDataAgent, protos.google.cloud.geminidataanalytics.v1beta.IOperationMetadata>, protos.google.longrunning.IOperation | null | undefined, {} | null | undefined>
Returns
Type Description
void

updateDataAgentSync(request, options)

updateDataAgentSync(request?: protos.google.cloud.geminidataanalytics.v1beta.IUpdateDataAgentRequest, options?: CallOptions): Promise<[
        protos.google.cloud.geminidataanalytics.v1beta.IDataAgent,
        protos.google.cloud.geminidataanalytics.v1beta.IUpdateDataAgentRequest | undefined,
        {} | undefined
    ]>;

Updates the parameters of a single DataAgent synchronously.

Parameters
Name Description
request IUpdateDataAgentRequest

The request object that will be sent.
options CallOptions

Call options. See CallOptions for more details.
Returns
Type Description
Promise<[ protos.google.cloud.geminidataanalytics.v1beta.IDataAgent, protos.google.cloud.geminidataanalytics.v1beta.IUpdateDataAgentRequest | undefined, {} | undefined ]>

{Promise} - The promise which resolves to an array. The first element of the array is an object representing DataAgent. 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
   *  DataAgent 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 with non-default values
   *  present in the request will be overwritten. If a wildcard mask is provided,
   *  all fields will be overwritten.
   */
  // const updateMask = {}
  /**
   *  Required. The resource being updated.
   */
  // const dataAgent = {}
  /**
   *  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 Geminidataanalytics library
  const {DataAgentServiceClient} = require('@google-cloud/geminidataanalytics').v1beta;

  // Instantiates a client
  const geminidataanalyticsClient = new DataAgentServiceClient();

  async function callUpdateDataAgentSync() {
    // Construct request
    const request = {
      dataAgent,
    };

    // Run request
    const response = await geminidataanalyticsClient.updateDataAgentSync(request);
    console.log(response);
  }

  callUpdateDataAgentSync();

updateDataAgentSync(request, options, callback)

updateDataAgentSync(request: protos.google.cloud.geminidataanalytics.v1beta.IUpdateDataAgentRequest, options: CallOptions, callback: Callback<protos.google.cloud.geminidataanalytics.v1beta.IDataAgent, protos.google.cloud.geminidataanalytics.v1beta.IUpdateDataAgentRequest | null | undefined, {} | null | undefined>): void;
Parameters
Name Description
request IUpdateDataAgentRequest
options CallOptions
callback Callback<protos.google.cloud.geminidataanalytics.v1beta.IDataAgent, protos.google.cloud.geminidataanalytics.v1beta.IUpdateDataAgentRequest | null | undefined, {} | null | undefined>
Returns
Type Description
void

updateDataAgentSync(request, callback)

updateDataAgentSync(request: protos.google.cloud.geminidataanalytics.v1beta.IUpdateDataAgentRequest, callback: Callback<protos.google.cloud.geminidataanalytics.v1beta.IDataAgent, protos.google.cloud.geminidataanalytics.v1beta.IUpdateDataAgentRequest | null | undefined, {} | null | undefined>): void;
Parameters
Name Description
request IUpdateDataAgentRequest
callback Callback<protos.google.cloud.geminidataanalytics.v1beta.IDataAgent, protos.google.cloud.geminidataanalytics.v1beta.IUpdateDataAgentRequest | null | undefined, {} | null | undefined>
Returns
Type Description
void