Class v1alpha.SchemaServiceClient (1.2.0)

Service for managing Schemas. v1alpha

Package

Constructors

(constructor)(opts, gaxInstance)

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

Construct an instance of SchemaServiceClient.

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

Properties

apiEndpoint

static get apiEndpoint(): string;

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

auth

auth: gax.GoogleAuth;

descriptors

descriptors: Descriptors;

innerApiCalls

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

locationsClient

locationsClient: LocationsClient;

operationsClient

operationsClient: gax.OperationsClient;

pathTemplates

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

port

static get port(): number;

The port for this API service.

schemaServiceStub

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

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.

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

checkCreateSchemaProgress(name)

checkCreateSchemaProgress(name: string): Promise<LROperation<protos.google.cloud.discoveryengine.v1alpha.Schema, protos.google.cloud.discoveryengine.v1alpha.CreateSchemaMetadata>>;

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

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

Returns
Type	Description
`Promise<LROperation<protos.google.cloud.discoveryengine.v1alpha.Schema, protos.google.cloud.discoveryengine.v1alpha.CreateSchemaMetadata>>`	{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 data store resource name, in the format of
   *  `projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}`.
   */
  // const parent = 'abc123'
  /**
   *  Required. The Schema google.cloud.discoveryengine.v1alpha.Schema  to
   *  create.
   */
  // const schema = {}
  /**
   *  Required. The ID to use for the
   *  Schema google.cloud.discoveryengine.v1alpha.Schema, which will become
   *  the final component of the
   *  Schema.name google.cloud.discoveryengine.v1alpha.Schema.name.
   *  This field should conform to
   *  RFC-1034 (https://tools.ietf.org/html/rfc1034) standard with a length
   *  limit of 63 characters.
   */
  // const schemaId = 'abc123'

  // Imports the Discoveryengine library
  const {SchemaServiceClient} = require('@google-cloud/discoveryengine').v1alpha;

  // Instantiates a client
  const discoveryengineClient = new SchemaServiceClient();

  async function callCreateSchema() {
    // Construct request
    const request = {
      parent,
      schema,
      schemaId,
    };

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

  callCreateSchema();

checkDeleteSchemaProgress(name)

checkDeleteSchemaProgress(name: string): Promise<LROperation<protos.google.protobuf.Empty, protos.google.cloud.discoveryengine.v1alpha.DeleteSchemaMetadata>>;

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

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

Returns
Type	Description
`Promise<LROperation<protos.google.protobuf.Empty, protos.google.cloud.discoveryengine.v1alpha.DeleteSchemaMetadata>>`	{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 full resource name of the schema, in the format of
   *  `projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}/schemas/{schema}`.
   */
  // const name = 'abc123'

  // Imports the Discoveryengine library
  const {SchemaServiceClient} = require('@google-cloud/discoveryengine').v1alpha;

  // Instantiates a client
  const discoveryengineClient = new SchemaServiceClient();

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

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

  callDeleteSchema();

checkUpdateSchemaProgress(name)

checkUpdateSchemaProgress(name: string): Promise<LROperation<protos.google.cloud.discoveryengine.v1alpha.Schema, protos.google.cloud.discoveryengine.v1alpha.UpdateSchemaMetadata>>;

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

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

Returns
Type	Description
`Promise<LROperation<protos.google.cloud.discoveryengine.v1alpha.Schema, protos.google.cloud.discoveryengine.v1alpha.UpdateSchemaMetadata>>`	{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 Schema google.cloud.discoveryengine.v1alpha.Schema  to
   *  update.
   */
  // const schema = {}
  /**
   *  If set to true, and the
   *  Schema google.cloud.discoveryengine.v1alpha.Schema  is not found, a new
   *  Schema google.cloud.discoveryengine.v1alpha.Schema  will be created. In
   *  this situation, `update_mask` is ignored.
   */
  // const allowMissing = true

  // Imports the Discoveryengine library
  const {SchemaServiceClient} = require('@google-cloud/discoveryengine').v1alpha;

  // Instantiates a client
  const discoveryengineClient = new SchemaServiceClient();

  async function callUpdateSchema() {
    // Construct request
    const request = {
      schema,
    };

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

  callUpdateSchema();

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.

createSchema(request, options)

createSchema(request?: protos.google.cloud.discoveryengine.v1alpha.ICreateSchemaRequest, options?: CallOptions): Promise<[
        LROperation<protos.google.cloud.discoveryengine.v1alpha.ISchema, protos.google.cloud.discoveryengine.v1alpha.ICreateSchemaMetadata>,
        protos.google.longrunning.IOperation | undefined,
        {} | undefined
    ]>;

Creates a Schema.

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

Returns
Type	Description
`Promise<[ LROperation<protos.google.cloud.discoveryengine.v1alpha.ISchema, protos.google.cloud.discoveryengine.v1alpha.ICreateSchemaMetadata>, 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 data store resource name, in the format of
   *  `projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}`.
   */
  // const parent = 'abc123'
  /**
   *  Required. The Schema google.cloud.discoveryengine.v1alpha.Schema  to
   *  create.
   */
  // const schema = {}
  /**
   *  Required. The ID to use for the
   *  Schema google.cloud.discoveryengine.v1alpha.Schema, which will become
   *  the final component of the
   *  Schema.name google.cloud.discoveryengine.v1alpha.Schema.name.
   *  This field should conform to
   *  RFC-1034 (https://tools.ietf.org/html/rfc1034) standard with a length
   *  limit of 63 characters.
   */
  // const schemaId = 'abc123'

  // Imports the Discoveryengine library
  const {SchemaServiceClient} = require('@google-cloud/discoveryengine').v1alpha;

  // Instantiates a client
  const discoveryengineClient = new SchemaServiceClient();

  async function callCreateSchema() {
    // Construct request
    const request = {
      parent,
      schema,
      schemaId,
    };

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

  callCreateSchema();

createSchema(request, options, callback)

createSchema(request: protos.google.cloud.discoveryengine.v1alpha.ICreateSchemaRequest, options: CallOptions, callback: Callback<LROperation<protos.google.cloud.discoveryengine.v1alpha.ISchema, protos.google.cloud.discoveryengine.v1alpha.ICreateSchemaMetadata>, protos.google.longrunning.IOperation | null | undefined, {} | null | undefined>): void;

Parameters
Name	Description
`request`	`ICreateSchemaRequest`
`options`	`CallOptions`
`callback`	`Callback<LROperation<protos.google.cloud.discoveryengine.v1alpha.ISchema, protos.google.cloud.discoveryengine.v1alpha.ICreateSchemaMetadata>, protos.google.longrunning.IOperation \| null \| undefined, {} \| null \| undefined>`

Returns
Type	Description
`void`

createSchema(request, callback)

createSchema(request: protos.google.cloud.discoveryengine.v1alpha.ICreateSchemaRequest, callback: Callback<LROperation<protos.google.cloud.discoveryengine.v1alpha.ISchema, protos.google.cloud.discoveryengine.v1alpha.ICreateSchemaMetadata>, protos.google.longrunning.IOperation | null | undefined, {} | null | undefined>): void;

Parameters
Name	Description
`request`	`ICreateSchemaRequest`
`callback`	`Callback<LROperation<protos.google.cloud.discoveryengine.v1alpha.ISchema, protos.google.cloud.discoveryengine.v1alpha.ICreateSchemaMetadata>, 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: ''});

deleteSchema(request, options)

deleteSchema(request?: protos.google.cloud.discoveryengine.v1alpha.IDeleteSchemaRequest, options?: CallOptions): Promise<[
        LROperation<protos.google.protobuf.IEmpty, protos.google.cloud.discoveryengine.v1alpha.IDeleteSchemaMetadata>,
        protos.google.longrunning.IOperation | undefined,
        {} | undefined
    ]>;

Deletes a Schema.

Parameters
Name	Description
`request`	`IDeleteSchemaRequest` 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.discoveryengine.v1alpha.IDeleteSchemaMetadata>, 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 full resource name of the schema, in the format of
   *  `projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}/schemas/{schema}`.
   */
  // const name = 'abc123'

  // Imports the Discoveryengine library
  const {SchemaServiceClient} = require('@google-cloud/discoveryengine').v1alpha;

  // Instantiates a client
  const discoveryengineClient = new SchemaServiceClient();

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

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

  callDeleteSchema();

deleteSchema(request, options, callback)

deleteSchema(request: protos.google.cloud.discoveryengine.v1alpha.IDeleteSchemaRequest, options: CallOptions, callback: Callback<LROperation<protos.google.protobuf.IEmpty, protos.google.cloud.discoveryengine.v1alpha.IDeleteSchemaMetadata>, protos.google.longrunning.IOperation | null | undefined, {} | null | undefined>): void;

Parameters
Name	Description
`request`	`IDeleteSchemaRequest`
`options`	`CallOptions`
`callback`	`Callback<LROperation<protos.google.protobuf.IEmpty, protos.google.cloud.discoveryengine.v1alpha.IDeleteSchemaMetadata>, protos.google.longrunning.IOperation \| null \| undefined, {} \| null \| undefined>`

Returns
Type	Description
`void`

deleteSchema(request, callback)

deleteSchema(request: protos.google.cloud.discoveryengine.v1alpha.IDeleteSchemaRequest, callback: Callback<LROperation<protos.google.protobuf.IEmpty, protos.google.cloud.discoveryengine.v1alpha.IDeleteSchemaMetadata>, protos.google.longrunning.IOperation | null | undefined, {} | null | undefined>): void;

Parameters
Name	Description
`request`	`IDeleteSchemaRequest`
`callback`	`Callback<LROperation<protos.google.protobuf.IEmpty, protos.google.cloud.discoveryengine.v1alpha.IDeleteSchemaMetadata>, protos.google.longrunning.IOperation \| null \| undefined, {} \| null \| undefined>`

Returns
Type	Description
`void`

getLocation(request, options, callback)

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

Gets information about a location.

Parameters
Name	Description
`request`	`LocationProtos.google.cloud.location.IGetLocationRequest` The request object that will be sent.
`options`	`CallOptions \| Callback<google.cloud.location.ILocation, google.cloud.location.IGetLocationRequest \| null \| undefined, {} \| null \| undefined>` Call options. See CallOptions for more details.
`callback`	`Callback<google.cloud.location.ILocation, google.cloud.location.IGetLocationRequest \| null \| undefined, {} \| null \| undefined>`

Returns
Type	Description
`Promise<google.cloud.location.ILocation>`	{Promise} - The promise which resolves to an array. The first element of the array is an object representing . Please see the documentation for more details and examples.

Example


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

getOperation(request, options, callback)

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

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

Parameters
Name	Description
`request`	`GetOperationRequest` The request object that will be sent.
`options`	`CallOptions \| Callback<protos.google.longrunning.Operation, protos.google.longrunning.GetOperationRequest, {} \| null \| undefined>` Optional parameters. You can override the default settings for this call, e.g, timeout, retries, paginations, etc. See gax.CallOptions for the details.
`callback`	`Callback<protos.google.longrunning.Operation, protos.google.longrunning.GetOperationRequest, {} \| null \| undefined>` The function which will be called with the result of the API call. The second parameter to the callback is an object representing . {Promise} - The promise which resolves to an array. The first element of the array is an object representing . The promise has a method named "cancel" which cancels the ongoing API call.

Returns
Type	Description
`Promise<[protos.google.longrunning.Operation]>`

Example


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

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`

getSchema(request, options)

getSchema(request?: protos.google.cloud.discoveryengine.v1alpha.IGetSchemaRequest, options?: CallOptions): Promise<[
        protos.google.cloud.discoveryengine.v1alpha.ISchema,
        protos.google.cloud.discoveryengine.v1alpha.IGetSchemaRequest | undefined,
        {} | undefined
    ]>;

Gets a Schema.

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

Returns
Type	Description
`Promise<[ protos.google.cloud.discoveryengine.v1alpha.ISchema, protos.google.cloud.discoveryengine.v1alpha.IGetSchemaRequest \| undefined, {} \| undefined ]>`	{Promise} - The promise which resolves to an array. The first element of the array is an object representing Schema. 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 full resource name of the schema, in the format of
   *  `projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}/schemas/{schema}`.
   */
  // const name = 'abc123'

  // Imports the Discoveryengine library
  const {SchemaServiceClient} = require('@google-cloud/discoveryengine').v1alpha;

  // Instantiates a client
  const discoveryengineClient = new SchemaServiceClient();

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

    // Run request
    const response = await discoveryengineClient.getSchema(request);
    console.log(response);
  }

  callGetSchema();

getSchema(request, options, callback)

getSchema(request: protos.google.cloud.discoveryengine.v1alpha.IGetSchemaRequest, options: CallOptions, callback: Callback<protos.google.cloud.discoveryengine.v1alpha.ISchema, protos.google.cloud.discoveryengine.v1alpha.IGetSchemaRequest | null | undefined, {} | null | undefined>): void;

Parameters
Name	Description
`request`	`IGetSchemaRequest`
`options`	`CallOptions`
`callback`	`Callback<protos.google.cloud.discoveryengine.v1alpha.ISchema, protos.google.cloud.discoveryengine.v1alpha.IGetSchemaRequest \| null \| undefined, {} \| null \| undefined>`

Returns
Type	Description
`void`

getSchema(request, callback)

getSchema(request: protos.google.cloud.discoveryengine.v1alpha.IGetSchemaRequest, callback: Callback<protos.google.cloud.discoveryengine.v1alpha.ISchema, protos.google.cloud.discoveryengine.v1alpha.IGetSchemaRequest | null | undefined, {} | null | undefined>): void;

Parameters
Name	Description
`request`	`IGetSchemaRequest`
`callback`	`Callback<protos.google.cloud.discoveryengine.v1alpha.ISchema, protos.google.cloud.discoveryengine.v1alpha.IGetSchemaRequest \| null \| undefined, {} \| null \| undefined>`

Returns
Type	Description
`void`

initialize()

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

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

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

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

listLocationsAsync(request, options)

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

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

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

Parameters
Name	Description
`request`	`LocationProtos.google.cloud.location.IListLocationsRequest` The request object that will be sent.
`options`	`CallOptions` Call options. See CallOptions for more details.

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

Example


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

listOperationsAsync(request, options)

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

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

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

Parameters
Name	Description
`request`	`ListOperationsRequest` The request object that will be sent.
`options`	`CallOptions` Optional parameters. You can override the default settings for this call, e.g, timeout, retries, paginations, etc. See gax.CallOptions for the details.

Returns
Type	Description
`AsyncIterable<protos.google.longrunning.ListOperationsResponse>`	{Object} An iterable Object that conforms to iteration protocols.

Example


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

listSchemas(request, options)

listSchemas(request?: protos.google.cloud.discoveryengine.v1alpha.IListSchemasRequest, options?: CallOptions): Promise<[
        protos.google.cloud.discoveryengine.v1alpha.ISchema[],
        protos.google.cloud.discoveryengine.v1alpha.IListSchemasRequest | null,
        protos.google.cloud.discoveryengine.v1alpha.IListSchemasResponse
    ]>;

Gets a list of Schemas.

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

Returns

Type Description

Promise<[
        protos.google.cloud.discoveryengine.v1alpha.ISchema[],
        protos.google.cloud.discoveryengine.v1alpha.IListSchemasRequest | null,
        protos.google.cloud.discoveryengine.v1alpha.IListSchemasResponse
    ]>

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

listSchemas(request, options, callback)

listSchemas(request: protos.google.cloud.discoveryengine.v1alpha.IListSchemasRequest, options: CallOptions, callback: PaginationCallback<protos.google.cloud.discoveryengine.v1alpha.IListSchemasRequest, protos.google.cloud.discoveryengine.v1alpha.IListSchemasResponse | null | undefined, protos.google.cloud.discoveryengine.v1alpha.ISchema>): void;

Parameters
Name	Description
`request`	`IListSchemasRequest`
`options`	`CallOptions`
`callback`	`PaginationCallback<protos.google.cloud.discoveryengine.v1alpha.IListSchemasRequest, protos.google.cloud.discoveryengine.v1alpha.IListSchemasResponse \| null \| undefined, protos.google.cloud.discoveryengine.v1alpha.ISchema>`

Returns
Type	Description
`void`

listSchemas(request, callback)

listSchemas(request: protos.google.cloud.discoveryengine.v1alpha.IListSchemasRequest, callback: PaginationCallback<protos.google.cloud.discoveryengine.v1alpha.IListSchemasRequest, protos.google.cloud.discoveryengine.v1alpha.IListSchemasResponse | null | undefined, protos.google.cloud.discoveryengine.v1alpha.ISchema>): void;

Parameters
Name	Description
`request`	`IListSchemasRequest`
`callback`	`PaginationCallback<protos.google.cloud.discoveryengine.v1alpha.IListSchemasRequest, protos.google.cloud.discoveryengine.v1alpha.IListSchemasResponse \| null \| undefined, protos.google.cloud.discoveryengine.v1alpha.ISchema>`

Returns
Type	Description
`void`

listSchemasAsync(request, options)

listSchemasAsync(request?: protos.google.cloud.discoveryengine.v1alpha.IListSchemasRequest, options?: CallOptions): AsyncIterable<protos.google.cloud.discoveryengine.v1alpha.ISchema>;

Equivalent to listSchemas, but returns an iterable object.

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

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

Returns
Type	Description
`AsyncIterable<protos.google.cloud.discoveryengine.v1alpha.ISchema>`	{Object} An iterable Object that allows async iteration. When you iterate the returned iterable, each element will be an object representing Schema. The API will be called under the hood as needed, once per the page, so you can stop the iteration when you don't need more results. Please see the documentation for more details and examples.

Example


  /**
   * This snippet has been automatically generated and should be regarded as a code template only.
   * It will require modifications to work.
   * It may require correct/in-range values for request initialization.
   * TODO(developer): Uncomment these variables before running the sample.
   */
  /**
   *  Required. The parent data store resource name, in the format of
   *  `projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}`.
   */
  // const parent = 'abc123'
  /**
   *  The maximum number of
   *  Schema google.cloud.discoveryengine.v1alpha.Schema s to return. The
   *  service may return fewer than this value.
   *  If unspecified, at most 100
   *  Schema google.cloud.discoveryengine.v1alpha.Schema s will be returned.
   *  The maximum value is 1000; values above 1000 will be coerced to 1000.
   */
  // const pageSize = 1234
  /**
   *  A page token, received from a previous
   *  SchemaService.ListSchemas google.cloud.discoveryengine.v1alpha.SchemaService.ListSchemas 
   *  call. Provide this to retrieve the subsequent page.
   *  When paginating, all other parameters provided to
   *  SchemaService.ListSchemas google.cloud.discoveryengine.v1alpha.SchemaService.ListSchemas 
   *  must match the call that provided the page token.
   */
  // const pageToken = 'abc123'

  // Imports the Discoveryengine library
  const {SchemaServiceClient} = require('@google-cloud/discoveryengine').v1alpha;

  // Instantiates a client
  const discoveryengineClient = new SchemaServiceClient();

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

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

  callListSchemas();

listSchemasStream(request, options)

listSchemasStream(request?: protos.google.cloud.discoveryengine.v1alpha.IListSchemasRequest, options?: CallOptions): Transform;

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

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

matchBranchFromProjectLocationCollectionDataStoreBranchDocumentName(projectLocationCollectionDataStoreBranchDocumentName)

matchBranchFromProjectLocationCollectionDataStoreBranchDocumentName(projectLocationCollectionDataStoreBranchDocumentName: string): string | number;

Parse the branch from ProjectLocationCollectionDataStoreBranchDocument resource.

Parameter
Name	Description
`projectLocationCollectionDataStoreBranchDocumentName`	`string` A fully-qualified path representing project_location_collection_data_store_branch_document resource.

Returns
Type	Description
`string \| number`	{string} A string representing the branch.

matchBranchFromProjectLocationDataStoreBranchDocumentName(projectLocationDataStoreBranchDocumentName)

matchBranchFromProjectLocationDataStoreBranchDocumentName(projectLocationDataStoreBranchDocumentName: string): string | number;

Parse the branch from ProjectLocationDataStoreBranchDocument resource.

Parameter
Name	Description
`projectLocationDataStoreBranchDocumentName`	`string` A fully-qualified path representing project_location_data_store_branch_document resource.

Returns
Type	Description
`string \| number`	{string} A string representing the branch.

matchCollectionFromProjectLocationCollectionDataStoreBranchDocumentName(projectLocationCollectionDataStoreBranchDocumentName)

matchCollectionFromProjectLocationCollectionDataStoreBranchDocumentName(projectLocationCollectionDataStoreBranchDocumentName: string): string | number;

Parse the collection from ProjectLocationCollectionDataStoreBranchDocument resource.

Parameter
Name	Description
`projectLocationCollectionDataStoreBranchDocumentName`	`string` A fully-qualified path representing project_location_collection_data_store_branch_document resource.

Returns
Type	Description
`string \| number`	{string} A string representing the collection.

matchCollectionFromProjectLocationCollectionDataStoreConversationName(projectLocationCollectionDataStoreConversationName)

matchCollectionFromProjectLocationCollectionDataStoreConversationName(projectLocationCollectionDataStoreConversationName: string): string | number;

Parse the collection from ProjectLocationCollectionDataStoreConversation resource.

Parameter
Name	Description
`projectLocationCollectionDataStoreConversationName`	`string` A fully-qualified path representing project_location_collection_data_store_conversation resource.

Returns
Type	Description
`string \| number`	{string} A string representing the collection.

matchCollectionFromProjectLocationCollectionDataStoreName(projectLocationCollectionDataStoreName)

matchCollectionFromProjectLocationCollectionDataStoreName(projectLocationCollectionDataStoreName: string): string | number;

Parse the collection from ProjectLocationCollectionDataStore resource.

Parameter
Name	Description
`projectLocationCollectionDataStoreName`	`string` A fully-qualified path representing project_location_collection_data_store resource.

Returns
Type	Description
`string \| number`	{string} A string representing the collection.

matchCollectionFromProjectLocationCollectionDataStoreSchemaName(projectLocationCollectionDataStoreSchemaName)

matchCollectionFromProjectLocationCollectionDataStoreSchemaName(projectLocationCollectionDataStoreSchemaName: string): string | number;

Parse the collection from ProjectLocationCollectionDataStoreSchema resource.

Parameter
Name	Description
`projectLocationCollectionDataStoreSchemaName`	`string` A fully-qualified path representing project_location_collection_data_store_schema resource.

Returns
Type	Description
`string \| number`	{string} A string representing the collection.

matchConversationFromProjectLocationCollectionDataStoreConversationName(projectLocationCollectionDataStoreConversationName)

matchConversationFromProjectLocationCollectionDataStoreConversationName(projectLocationCollectionDataStoreConversationName: string): string | number;

Parse the conversation from ProjectLocationCollectionDataStoreConversation resource.

Parameter
Name	Description
`projectLocationCollectionDataStoreConversationName`	`string` A fully-qualified path representing project_location_collection_data_store_conversation resource.

Returns
Type	Description
`string \| number`	{string} A string representing the conversation.

matchConversationFromProjectLocationDataStoreConversationName(projectLocationDataStoreConversationName)

matchConversationFromProjectLocationDataStoreConversationName(projectLocationDataStoreConversationName: string): string | number;

Parse the conversation from ProjectLocationDataStoreConversation resource.

Parameter
Name	Description
`projectLocationDataStoreConversationName`	`string` A fully-qualified path representing project_location_data_store_conversation resource.

Returns
Type	Description
`string \| number`	{string} A string representing the conversation.

matchDataStoreFromProjectLocationCollectionDataStoreBranchDocumentName(projectLocationCollectionDataStoreBranchDocumentName)

matchDataStoreFromProjectLocationCollectionDataStoreBranchDocumentName(projectLocationCollectionDataStoreBranchDocumentName: string): string | number;

Parse the data_store from ProjectLocationCollectionDataStoreBranchDocument resource.

Parameter
Name	Description
`projectLocationCollectionDataStoreBranchDocumentName`	`string` A fully-qualified path representing project_location_collection_data_store_branch_document resource.

Returns
Type	Description
`string \| number`	{string} A string representing the data_store.

matchDataStoreFromProjectLocationCollectionDataStoreConversationName(projectLocationCollectionDataStoreConversationName)

matchDataStoreFromProjectLocationCollectionDataStoreConversationName(projectLocationCollectionDataStoreConversationName: string): string | number;

Parse the data_store from ProjectLocationCollectionDataStoreConversation resource.

Parameter
Name	Description
`projectLocationCollectionDataStoreConversationName`	`string` A fully-qualified path representing project_location_collection_data_store_conversation resource.

Returns
Type	Description
`string \| number`	{string} A string representing the data_store.

matchDataStoreFromProjectLocationCollectionDataStoreName(projectLocationCollectionDataStoreName)

matchDataStoreFromProjectLocationCollectionDataStoreName(projectLocationCollectionDataStoreName: string): string | number;

Parse the data_store from ProjectLocationCollectionDataStore resource.

Parameter
Name	Description
`projectLocationCollectionDataStoreName`	`string` A fully-qualified path representing project_location_collection_data_store resource.

Returns
Type	Description
`string \| number`	{string} A string representing the data_store.

matchDataStoreFromProjectLocationCollectionDataStoreSchemaName(projectLocationCollectionDataStoreSchemaName)

matchDataStoreFromProjectLocationCollectionDataStoreSchemaName(projectLocationCollectionDataStoreSchemaName: string): string | number;

Parse the data_store from ProjectLocationCollectionDataStoreSchema resource.

Parameter
Name	Description
`projectLocationCollectionDataStoreSchemaName`	`string` A fully-qualified path representing project_location_collection_data_store_schema resource.

Returns
Type	Description
`string \| number`	{string} A string representing the data_store.

matchDataStoreFromProjectLocationDataStoreBranchDocumentName(projectLocationDataStoreBranchDocumentName)

matchDataStoreFromProjectLocationDataStoreBranchDocumentName(projectLocationDataStoreBranchDocumentName: string): string | number;

Parse the data_store from ProjectLocationDataStoreBranchDocument resource.

Parameter
Name	Description
`projectLocationDataStoreBranchDocumentName`	`string` A fully-qualified path representing project_location_data_store_branch_document resource.

Returns
Type	Description
`string \| number`	{string} A string representing the data_store.

matchDataStoreFromProjectLocationDataStoreConversationName(projectLocationDataStoreConversationName)

matchDataStoreFromProjectLocationDataStoreConversationName(projectLocationDataStoreConversationName: string): string | number;

Parse the data_store from ProjectLocationDataStoreConversation resource.

Parameter
Name	Description
`projectLocationDataStoreConversationName`	`string` A fully-qualified path representing project_location_data_store_conversation resource.

Returns
Type	Description
`string \| number`	{string} A string representing the data_store.

matchDataStoreFromProjectLocationDataStoreName(projectLocationDataStoreName)

matchDataStoreFromProjectLocationDataStoreName(projectLocationDataStoreName: string): string | number;

Parse the data_store from ProjectLocationDataStore resource.

Parameter
Name	Description
`projectLocationDataStoreName`	`string` A fully-qualified path representing project_location_data_store resource.

Returns
Type	Description
`string \| number`	{string} A string representing the data_store.

matchDataStoreFromProjectLocationDataStoreSchemaName(projectLocationDataStoreSchemaName)

matchDataStoreFromProjectLocationDataStoreSchemaName(projectLocationDataStoreSchemaName: string): string | number;

Parse the data_store from ProjectLocationDataStoreSchema resource.

Parameter
Name	Description
`projectLocationDataStoreSchemaName`	`string` A fully-qualified path representing project_location_data_store_schema resource.

Returns
Type	Description
`string \| number`	{string} A string representing the data_store.

matchDocumentFromProjectLocationCollectionDataStoreBranchDocumentName(projectLocationCollectionDataStoreBranchDocumentName)

matchDocumentFromProjectLocationCollectionDataStoreBranchDocumentName(projectLocationCollectionDataStoreBranchDocumentName: string): string | number;

Parse the document from ProjectLocationCollectionDataStoreBranchDocument resource.

Parameter
Name	Description
`projectLocationCollectionDataStoreBranchDocumentName`	`string` A fully-qualified path representing project_location_collection_data_store_branch_document resource.

Returns
Type	Description
`string \| number`	{string} A string representing the document.

matchDocumentFromProjectLocationDataStoreBranchDocumentName(projectLocationDataStoreBranchDocumentName)

matchDocumentFromProjectLocationDataStoreBranchDocumentName(projectLocationDataStoreBranchDocumentName: string): string | number;

Parse the document from ProjectLocationDataStoreBranchDocument resource.

Parameter
Name	Description
`projectLocationDataStoreBranchDocumentName`	`string` A fully-qualified path representing project_location_data_store_branch_document resource.

Returns
Type	Description
`string \| number`	{string} A string representing the document.

matchLocationFromProjectLocationCollectionDataStoreBranchDocumentName(projectLocationCollectionDataStoreBranchDocumentName)

matchLocationFromProjectLocationCollectionDataStoreBranchDocumentName(projectLocationCollectionDataStoreBranchDocumentName: string): string | number;

Parse the location from ProjectLocationCollectionDataStoreBranchDocument resource.

Parameter
Name	Description
`projectLocationCollectionDataStoreBranchDocumentName`	`string` A fully-qualified path representing project_location_collection_data_store_branch_document resource.

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

matchLocationFromProjectLocationCollectionDataStoreConversationName(projectLocationCollectionDataStoreConversationName)

matchLocationFromProjectLocationCollectionDataStoreConversationName(projectLocationCollectionDataStoreConversationName: string): string | number;

Parse the location from ProjectLocationCollectionDataStoreConversation resource.

Parameter
Name	Description
`projectLocationCollectionDataStoreConversationName`	`string` A fully-qualified path representing project_location_collection_data_store_conversation resource.

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

matchLocationFromProjectLocationCollectionDataStoreName(projectLocationCollectionDataStoreName)

matchLocationFromProjectLocationCollectionDataStoreName(projectLocationCollectionDataStoreName: string): string | number;

Parse the location from ProjectLocationCollectionDataStore resource.

Parameter
Name	Description
`projectLocationCollectionDataStoreName`	`string` A fully-qualified path representing project_location_collection_data_store resource.

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

matchLocationFromProjectLocationCollectionDataStoreSchemaName(projectLocationCollectionDataStoreSchemaName)

matchLocationFromProjectLocationCollectionDataStoreSchemaName(projectLocationCollectionDataStoreSchemaName: string): string | number;

Parse the location from ProjectLocationCollectionDataStoreSchema resource.

Parameter
Name	Description
`projectLocationCollectionDataStoreSchemaName`	`string` A fully-qualified path representing project_location_collection_data_store_schema resource.

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

matchLocationFromProjectLocationDataStoreBranchDocumentName(projectLocationDataStoreBranchDocumentName)

matchLocationFromProjectLocationDataStoreBranchDocumentName(projectLocationDataStoreBranchDocumentName: string): string | number;

Parse the location from ProjectLocationDataStoreBranchDocument resource.

Parameter
Name	Description
`projectLocationDataStoreBranchDocumentName`	`string` A fully-qualified path representing project_location_data_store_branch_document resource.

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

matchLocationFromProjectLocationDataStoreConversationName(projectLocationDataStoreConversationName)

matchLocationFromProjectLocationDataStoreConversationName(projectLocationDataStoreConversationName: string): string | number;

Parse the location from ProjectLocationDataStoreConversation resource.

Parameter
Name	Description
`projectLocationDataStoreConversationName`	`string` A fully-qualified path representing project_location_data_store_conversation resource.

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

matchLocationFromProjectLocationDataStoreName(projectLocationDataStoreName)

matchLocationFromProjectLocationDataStoreName(projectLocationDataStoreName: string): string | number;

Parse the location from ProjectLocationDataStore resource.

Parameter
Name	Description
`projectLocationDataStoreName`	`string` A fully-qualified path representing project_location_data_store resource.

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

matchLocationFromProjectLocationDataStoreSchemaName(projectLocationDataStoreSchemaName)

matchLocationFromProjectLocationDataStoreSchemaName(projectLocationDataStoreSchemaName: string): string | number;

Parse the location from ProjectLocationDataStoreSchema resource.

Parameter
Name	Description
`projectLocationDataStoreSchemaName`	`string` A fully-qualified path representing project_location_data_store_schema resource.

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

matchProjectFromProjectLocationCollectionDataStoreBranchDocumentName(projectLocationCollectionDataStoreBranchDocumentName)

matchProjectFromProjectLocationCollectionDataStoreBranchDocumentName(projectLocationCollectionDataStoreBranchDocumentName: string): string | number;

Parse the project from ProjectLocationCollectionDataStoreBranchDocument resource.

Parameter
Name	Description
`projectLocationCollectionDataStoreBranchDocumentName`	`string` A fully-qualified path representing project_location_collection_data_store_branch_document resource.

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

matchProjectFromProjectLocationCollectionDataStoreConversationName(projectLocationCollectionDataStoreConversationName)

matchProjectFromProjectLocationCollectionDataStoreConversationName(projectLocationCollectionDataStoreConversationName: string): string | number;

Parse the project from ProjectLocationCollectionDataStoreConversation resource.

Parameter
Name	Description
`projectLocationCollectionDataStoreConversationName`	`string` A fully-qualified path representing project_location_collection_data_store_conversation resource.

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

matchProjectFromProjectLocationCollectionDataStoreName(projectLocationCollectionDataStoreName)

matchProjectFromProjectLocationCollectionDataStoreName(projectLocationCollectionDataStoreName: string): string | number;

Parse the project from ProjectLocationCollectionDataStore resource.

Parameter
Name	Description
`projectLocationCollectionDataStoreName`	`string` A fully-qualified path representing project_location_collection_data_store resource.

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

matchProjectFromProjectLocationCollectionDataStoreSchemaName(projectLocationCollectionDataStoreSchemaName)

matchProjectFromProjectLocationCollectionDataStoreSchemaName(projectLocationCollectionDataStoreSchemaName: string): string | number;

Parse the project from ProjectLocationCollectionDataStoreSchema resource.

Parameter
Name	Description
`projectLocationCollectionDataStoreSchemaName`	`string` A fully-qualified path representing project_location_collection_data_store_schema resource.

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

matchProjectFromProjectLocationDataStoreBranchDocumentName(projectLocationDataStoreBranchDocumentName)

matchProjectFromProjectLocationDataStoreBranchDocumentName(projectLocationDataStoreBranchDocumentName: string): string | number;

Parse the project from ProjectLocationDataStoreBranchDocument resource.

Parameter
Name	Description
`projectLocationDataStoreBranchDocumentName`	`string` A fully-qualified path representing project_location_data_store_branch_document resource.

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

matchProjectFromProjectLocationDataStoreConversationName(projectLocationDataStoreConversationName)

matchProjectFromProjectLocationDataStoreConversationName(projectLocationDataStoreConversationName: string): string | number;

Parse the project from ProjectLocationDataStoreConversation resource.

Parameter
Name	Description
`projectLocationDataStoreConversationName`	`string` A fully-qualified path representing project_location_data_store_conversation resource.

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

matchProjectFromProjectLocationDataStoreName(projectLocationDataStoreName)

matchProjectFromProjectLocationDataStoreName(projectLocationDataStoreName: string): string | number;

Parse the project from ProjectLocationDataStore resource.

Parameter
Name	Description
`projectLocationDataStoreName`	`string` A fully-qualified path representing project_location_data_store resource.

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

matchProjectFromProjectLocationDataStoreSchemaName(projectLocationDataStoreSchemaName)

matchProjectFromProjectLocationDataStoreSchemaName(projectLocationDataStoreSchemaName: string): string | number;

Parse the project from ProjectLocationDataStoreSchema resource.

Parameter
Name	Description
`projectLocationDataStoreSchemaName`	`string` A fully-qualified path representing project_location_data_store_schema resource.

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

matchSchemaFromProjectLocationCollectionDataStoreSchemaName(projectLocationCollectionDataStoreSchemaName)

matchSchemaFromProjectLocationCollectionDataStoreSchemaName(projectLocationCollectionDataStoreSchemaName: string): string | number;

Parse the schema from ProjectLocationCollectionDataStoreSchema resource.

Parameter
Name	Description
`projectLocationCollectionDataStoreSchemaName`	`string` A fully-qualified path representing project_location_collection_data_store_schema resource.

Returns
Type	Description
`string \| number`	{string} A string representing the schema.

matchSchemaFromProjectLocationDataStoreSchemaName(projectLocationDataStoreSchemaName)

matchSchemaFromProjectLocationDataStoreSchemaName(projectLocationDataStoreSchemaName: string): string | number;

Parse the schema from ProjectLocationDataStoreSchema resource.

Parameter
Name	Description
`projectLocationDataStoreSchemaName`	`string` A fully-qualified path representing project_location_data_store_schema resource.

Returns
Type	Description
`string \| number`	{string} A string representing the schema.

projectLocationCollectionDataStoreBranchDocumentPath(project, location, collection, dataStore, branch, document)

projectLocationCollectionDataStoreBranchDocumentPath(project: string, location: string, collection: string, dataStore: string, branch: string, document: string): string;

Return a fully-qualified projectLocationCollectionDataStoreBranchDocument resource name string.

Parameters
Name	Description
`project`	`string`
`location`	`string`
`collection`	`string`
`dataStore`	`string`
`branch`	`string`
`document`	`string`

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

projectLocationCollectionDataStoreConversationPath(project, location, collection, dataStore, conversation)

projectLocationCollectionDataStoreConversationPath(project: string, location: string, collection: string, dataStore: string, conversation: string): string;

Return a fully-qualified projectLocationCollectionDataStoreConversation resource name string.

Parameters
Name	Description
`project`	`string`
`location`	`string`
`collection`	`string`
`dataStore`	`string`
`conversation`	`string`

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

projectLocationCollectionDataStorePath(project, location, collection, dataStore)

projectLocationCollectionDataStorePath(project: string, location: string, collection: string, dataStore: string): string;

Return a fully-qualified projectLocationCollectionDataStore resource name string.

Parameters
Name	Description
`project`	`string`
`location`	`string`
`collection`	`string`
`dataStore`	`string`

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

projectLocationCollectionDataStoreSchemaPath(project, location, collection, dataStore, schema)

projectLocationCollectionDataStoreSchemaPath(project: string, location: string, collection: string, dataStore: string, schema: string): string;

Return a fully-qualified projectLocationCollectionDataStoreSchema resource name string.

Parameters
Name	Description
`project`	`string`
`location`	`string`
`collection`	`string`
`dataStore`	`string`
`schema`	`string`

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

projectLocationDataStoreBranchDocumentPath(project, location, dataStore, branch, document)

projectLocationDataStoreBranchDocumentPath(project: string, location: string, dataStore: string, branch: string, document: string): string;

Return a fully-qualified projectLocationDataStoreBranchDocument resource name string.

Parameters
Name	Description
`project`	`string`
`location`	`string`
`dataStore`	`string`
`branch`	`string`
`document`	`string`

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

projectLocationDataStoreConversationPath(project, location, dataStore, conversation)

projectLocationDataStoreConversationPath(project: string, location: string, dataStore: string, conversation: string): string;

Return a fully-qualified projectLocationDataStoreConversation resource name string.

Parameters
Name	Description
`project`	`string`
`location`	`string`
`dataStore`	`string`
`conversation`	`string`

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

projectLocationDataStorePath(project, location, dataStore)

projectLocationDataStorePath(project: string, location: string, dataStore: string): string;

Return a fully-qualified projectLocationDataStore resource name string.

Parameters
Name	Description
`project`	`string`
`location`	`string`
`dataStore`	`string`

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

projectLocationDataStoreSchemaPath(project, location, dataStore, schema)

projectLocationDataStoreSchemaPath(project: string, location: string, dataStore: string, schema: string): string;

Return a fully-qualified projectLocationDataStoreSchema resource name string.

Parameters
Name	Description
`project`	`string`
`location`	`string`
`dataStore`	`string`
`schema`	`string`

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

updateSchema(request, options)

updateSchema(request?: protos.google.cloud.discoveryengine.v1alpha.IUpdateSchemaRequest, options?: CallOptions): Promise<[
        LROperation<protos.google.cloud.discoveryengine.v1alpha.ISchema, protos.google.cloud.discoveryengine.v1alpha.IUpdateSchemaMetadata>,
        protos.google.longrunning.IOperation | undefined,
        {} | undefined
    ]>;

Updates a Schema.

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

Returns
Type	Description
`Promise<[ LROperation<protos.google.cloud.discoveryengine.v1alpha.ISchema, protos.google.cloud.discoveryengine.v1alpha.IUpdateSchemaMetadata>, 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 Schema google.cloud.discoveryengine.v1alpha.Schema  to
   *  update.
   */
  // const schema = {}
  /**
   *  If set to true, and the
   *  Schema google.cloud.discoveryengine.v1alpha.Schema  is not found, a new
   *  Schema google.cloud.discoveryengine.v1alpha.Schema  will be created. In
   *  this situation, `update_mask` is ignored.
   */
  // const allowMissing = true

  // Imports the Discoveryengine library
  const {SchemaServiceClient} = require('@google-cloud/discoveryengine').v1alpha;

  // Instantiates a client
  const discoveryengineClient = new SchemaServiceClient();

  async function callUpdateSchema() {
    // Construct request
    const request = {
      schema,
    };

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

  callUpdateSchema();

updateSchema(request, options, callback)

updateSchema(request: protos.google.cloud.discoveryengine.v1alpha.IUpdateSchemaRequest, options: CallOptions, callback: Callback<LROperation<protos.google.cloud.discoveryengine.v1alpha.ISchema, protos.google.cloud.discoveryengine.v1alpha.IUpdateSchemaMetadata>, protos.google.longrunning.IOperation | null | undefined, {} | null | undefined>): void;

Parameters
Name	Description
`request`	`IUpdateSchemaRequest`
`options`	`CallOptions`
`callback`	`Callback<LROperation<protos.google.cloud.discoveryengine.v1alpha.ISchema, protos.google.cloud.discoveryengine.v1alpha.IUpdateSchemaMetadata>, protos.google.longrunning.IOperation \| null \| undefined, {} \| null \| undefined>`

Returns
Type	Description
`void`

updateSchema(request, callback)

updateSchema(request: protos.google.cloud.discoveryengine.v1alpha.IUpdateSchemaRequest, callback: Callback<LROperation<protos.google.cloud.discoveryengine.v1alpha.ISchema, protos.google.cloud.discoveryengine.v1alpha.IUpdateSchemaMetadata>, protos.google.longrunning.IOperation | null | undefined, {} | null | undefined>): void;

Parameters
Name	Description
`request`	`IUpdateSchemaRequest`
`callback`	`Callback<LROperation<protos.google.cloud.discoveryengine.v1alpha.ISchema, protos.google.cloud.discoveryengine.v1alpha.IUpdateSchemaMetadata>, protos.google.longrunning.IOperation \| null \| undefined, {} \| null \| undefined>`

Returns
Type	Description
`void`