Class v1.HealthCheckServiceClient (0.4.1)

HealthCheckService provides an interface for Vertex AI Vision Cluster Health Check. v1

Package

@google-cloud/visionai

Constructors

(constructor)(opts, gaxInstance)

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

Construct an instance of HealthCheckServiceClient.

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

descriptors

descriptors: Descriptors;

healthCheckServiceStub

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

iamClient

iamClient: IamClient;

innerApiCalls

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

locationsClient

locationsClient: LocationsClient;

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

analysisPath(project, location, cluster, analysis)

analysisPath(project: string, location: string, cluster: string, analysis: string): string;

Return a fully-qualified analysis resource name string.

Parameters
Name Description
project string
location string
cluster string
analysis string
Returns
Type Description
string

{string} Resource name string.

annotationPath(projectNumber, location, corpus, asset, annotation)

annotationPath(projectNumber: string, location: string, corpus: string, asset: string, annotation: string): string;

Return a fully-qualified annotation resource name string.

Parameters
Name Description
projectNumber string
location string
corpus string
asset string
annotation string
Returns
Type Description
string

{string} Resource name string.

applicationPath(project, location, application)

applicationPath(project: string, location: string, application: string): string;

Return a fully-qualified application resource name string.

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

{string} Resource name string.

assetPath(projectNumber, location, corpus, asset)

assetPath(projectNumber: string, location: string, corpus: string, asset: string): string;

Return a fully-qualified asset resource name string.

Parameters
Name Description
projectNumber string
location string
corpus string
asset string
Returns
Type Description
string

{string} Resource name string.

channelPath(project, location, cluster, channel)

channelPath(project: string, location: string, cluster: string, channel: string): string;

Return a fully-qualified channel resource name string.

Parameters
Name Description
project string
location string
cluster string
channel string
Returns
Type Description
string

{string} Resource name string.

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.

clusterPath(project, location, cluster)

clusterPath(project: string, location: string, cluster: string): string;

Return a fully-qualified cluster resource name string.

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

{string} Resource name string.

collectionPath(projectNumber, location, corpus, collection)

collectionPath(projectNumber: string, location: string, corpus: string, collection: string): string;

Return a fully-qualified collection resource name string.

Parameters
Name Description
projectNumber string
location string
corpus string
collection string
Returns
Type Description
string

{string} Resource name string.

corpusPath(projectNumber, location, corpus)

corpusPath(projectNumber: string, location: string, corpus: string): string;

Return a fully-qualified corpus resource name string.

Parameters
Name Description
projectNumber string
location string
corpus string
Returns
Type Description
string

{string} Resource name string.

dataSchemaPath(projectNumber, location, corpus, dataSchema)

dataSchemaPath(projectNumber: string, location: string, corpus: string, dataSchema: string): string;

Return a fully-qualified dataSchema resource name string.

Parameters
Name Description
projectNumber string
location string
corpus string
dataSchema string
Returns
Type Description
string

{string} Resource name string.

draftPath(project, location, application, draft)

draftPath(project: string, location: string, application: string, draft: string): string;

Return a fully-qualified draft resource name string.

Parameters
Name Description
project string
location string
application string
draft string
Returns
Type Description
string

{string} Resource name string.

eventPath(project, location, cluster, event)

eventPath(project: string, location: string, cluster: string, event: string): string;

Return a fully-qualified event resource name string.

Parameters
Name Description
project string
location string
cluster string
event string
Returns
Type Description
string

{string} Resource name string.

getIamPolicy(request, options, callback)

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

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

Parameters
Name Description
request IamProtos.google.iam.v1.GetIamPolicyRequest

The request object that will be sent.
options CallOptions | Callback<google.iam.v1.Policy, google.iam.v1.GetIamPolicyRequest | null | undefined, {} | null | undefined>

Optional parameters. You can override the default settings for this call, e.g, timeout, retries, paginations, etc. See gax.CallOptions for the details.
callback Callback<google.iam.v1.Policy, google.iam.v1.GetIamPolicyRequest | null | undefined, {} | null | undefined>

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

The second parameter to the callback is an object representing .
Returns
Type Description
Promise<[google.iam.v1.Policy]>

{Promise} - The promise which resolves to an array. The first element of the array is an object representing . The promise has a method named "cancel" which cancels the ongoing API call.

getLocation(request, options, callback)

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

Gets information about a location.

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

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

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

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

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

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

healthCheck(request, options)

healthCheck(request?: protos.google.cloud.visionai.v1.IHealthCheckRequest, options?: CallOptions): Promise<[
        protos.google.cloud.visionai.v1.IHealthCheckResponse,
        protos.google.cloud.visionai.v1.IHealthCheckRequest | undefined,
        {} | undefined
    ]>;

HealthCheck method checks the health status of the cluster.

Parameters
Name Description
request IHealthCheckRequest

The request object that will be sent.
options CallOptions

Call options. See CallOptions for more details.
Returns
Type Description
Promise<[ protos.google.cloud.visionai.v1.IHealthCheckResponse, protos.google.cloud.visionai.v1.IHealthCheckRequest | undefined, {} | undefined ]>

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

  // Imports the Visionai library
  const {HealthCheckServiceClient} = require('@google-cloud/visionai').v1;

  // Instantiates a client
  const visionaiClient = new HealthCheckServiceClient();

  async function callHealthCheck() {
    // Construct request
    const request = {
    };

    // Run request
    const response = await visionaiClient.healthCheck(request);
    console.log(response);
  }

  callHealthCheck();

healthCheck(request, options, callback)

healthCheck(request: protos.google.cloud.visionai.v1.IHealthCheckRequest, options: CallOptions, callback: Callback<protos.google.cloud.visionai.v1.IHealthCheckResponse, protos.google.cloud.visionai.v1.IHealthCheckRequest | null | undefined, {} | null | undefined>): void;
Parameters
Name Description
request IHealthCheckRequest
options CallOptions
callback Callback<protos.google.cloud.visionai.v1.IHealthCheckResponse, protos.google.cloud.visionai.v1.IHealthCheckRequest | null | undefined, {} | null | undefined>
Returns
Type Description
void

healthCheck(request, callback)

healthCheck(request: protos.google.cloud.visionai.v1.IHealthCheckRequest, callback: Callback<protos.google.cloud.visionai.v1.IHealthCheckResponse, protos.google.cloud.visionai.v1.IHealthCheckRequest | null | undefined, {} | null | undefined>): void;
Parameters
Name Description
request IHealthCheckRequest
callback Callback<protos.google.cloud.visionai.v1.IHealthCheckResponse, protos.google.cloud.visionai.v1.IHealthCheckRequest | null | undefined, {} | null | undefined>
Returns
Type Description
void

indexEndpointPath(project, location, indexEndpoint)

indexEndpointPath(project: string, location: string, indexEndpoint: string): string;

Return a fully-qualified indexEndpoint resource name string.

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

{string} Resource name string.

indexPath(projectNumber, location, corpus, index)

indexPath(projectNumber: string, location: string, corpus: string, index: string): string;

Return a fully-qualified index resource name string.

Parameters
Name Description
projectNumber string
location string
corpus string
index string
Returns
Type Description
string

{string} Resource name string.

initialize()

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

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

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

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

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

instancePath(project, location, application, instance)

instancePath(project: string, location: string, application: string, instance: string): string;

Return a fully-qualified instance resource name string.

Parameters
Name Description
project string
location string
application string
instance string
Returns
Type Description
string

{string} Resource name string.

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
}

matchAnalysisFromAnalysisName(analysisName)

matchAnalysisFromAnalysisName(analysisName: string): string | number;

Parse the analysis from Analysis resource.

Parameter
Name Description
analysisName string

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

{string} A string representing the analysis.

matchAnnotationFromAnnotationName(annotationName)

matchAnnotationFromAnnotationName(annotationName: string): string | number;

Parse the annotation from Annotation resource.

Parameter
Name Description
annotationName string

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

{string} A string representing the annotation.

matchApplicationFromApplicationName(applicationName)

matchApplicationFromApplicationName(applicationName: string): string | number;

Parse the application from Application resource.

Parameter
Name Description
applicationName string

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

{string} A string representing the application.

matchApplicationFromDraftName(draftName)

matchApplicationFromDraftName(draftName: string): string | number;

Parse the application from Draft resource.

Parameter
Name Description
draftName string

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

{string} A string representing the application.

matchApplicationFromInstanceName(instanceName)

matchApplicationFromInstanceName(instanceName: string): string | number;

Parse the application from Instance resource.

Parameter
Name Description
instanceName string

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

{string} A string representing the application.

matchAssetFromAnnotationName(annotationName)

matchAssetFromAnnotationName(annotationName: string): string | number;

Parse the asset from Annotation resource.

Parameter
Name Description
annotationName string

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

{string} A string representing the asset.

matchAssetFromAssetName(assetName)

matchAssetFromAssetName(assetName: string): string | number;

Parse the asset from Asset resource.

Parameter
Name Description
assetName string

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

{string} A string representing the asset.

matchChannelFromChannelName(channelName)

matchChannelFromChannelName(channelName: string): string | number;

Parse the channel from Channel resource.

Parameter
Name Description
channelName string

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

{string} A string representing the channel.

matchClusterFromAnalysisName(analysisName)

matchClusterFromAnalysisName(analysisName: string): string | number;

Parse the cluster from Analysis resource.

Parameter
Name Description
analysisName string

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

{string} A string representing the cluster.

matchClusterFromChannelName(channelName)

matchClusterFromChannelName(channelName: string): string | number;

Parse the cluster from Channel resource.

Parameter
Name Description
channelName string

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

{string} A string representing the cluster.

matchClusterFromClusterName(clusterName)

matchClusterFromClusterName(clusterName: string): string | number;

Parse the cluster from Cluster resource.

Parameter
Name Description
clusterName string

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

{string} A string representing the cluster.

matchClusterFromEventName(eventName)

matchClusterFromEventName(eventName: string): string | number;

Parse the cluster from Event resource.

Parameter
Name Description
eventName string

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

{string} A string representing the cluster.

matchClusterFromProcessName(processName)

matchClusterFromProcessName(processName: string): string | number;

Parse the cluster from Process resource.

Parameter
Name Description
processName string

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

{string} A string representing the cluster.

matchClusterFromSeriesName(seriesName)

matchClusterFromSeriesName(seriesName: string): string | number;

Parse the cluster from Series resource.

Parameter
Name Description
seriesName string

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

{string} A string representing the cluster.

matchClusterFromStreamName(streamName)

matchClusterFromStreamName(streamName: string): string | number;

Parse the cluster from Stream resource.

Parameter
Name Description
streamName string

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

{string} A string representing the cluster.

matchCollectionFromCollectionName(collectionName)

matchCollectionFromCollectionName(collectionName: string): string | number;

Parse the collection from Collection resource.

Parameter
Name Description
collectionName string

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

{string} A string representing the collection.

matchCorpusFromAnnotationName(annotationName)

matchCorpusFromAnnotationName(annotationName: string): string | number;

Parse the corpus from Annotation resource.

Parameter
Name Description
annotationName string

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

{string} A string representing the corpus.

matchCorpusFromAssetName(assetName)

matchCorpusFromAssetName(assetName: string): string | number;

Parse the corpus from Asset resource.

Parameter
Name Description
assetName string

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

{string} A string representing the corpus.

matchCorpusFromCollectionName(collectionName)

matchCorpusFromCollectionName(collectionName: string): string | number;

Parse the corpus from Collection resource.

Parameter
Name Description
collectionName string

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

{string} A string representing the corpus.

matchCorpusFromCorpusName(corpusName)

matchCorpusFromCorpusName(corpusName: string): string | number;

Parse the corpus from Corpus resource.

Parameter
Name Description
corpusName string

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

{string} A string representing the corpus.

matchCorpusFromDataSchemaName(dataSchemaName)

matchCorpusFromDataSchemaName(dataSchemaName: string): string | number;

Parse the corpus from DataSchema resource.

Parameter
Name Description
dataSchemaName string

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

{string} A string representing the corpus.

matchCorpusFromIndexName(indexName)

matchCorpusFromIndexName(indexName: string): string | number;

Parse the corpus from Index resource.

Parameter
Name Description
indexName string

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

{string} A string representing the corpus.

matchCorpusFromSearchConfigName(searchConfigName)

matchCorpusFromSearchConfigName(searchConfigName: string): string | number;

Parse the corpus from SearchConfig resource.

Parameter
Name Description
searchConfigName string

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

{string} A string representing the corpus.

matchCorpusFromSearchHypernymName(searchHypernymName)

matchCorpusFromSearchHypernymName(searchHypernymName: string): string | number;

Parse the corpus from SearchHypernym resource.

Parameter
Name Description
searchHypernymName string

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

{string} A string representing the corpus.

matchDataSchemaFromDataSchemaName(dataSchemaName)

matchDataSchemaFromDataSchemaName(dataSchemaName: string): string | number;

Parse the data_schema from DataSchema resource.

Parameter
Name Description
dataSchemaName string

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

{string} A string representing the data_schema.

matchDraftFromDraftName(draftName)

matchDraftFromDraftName(draftName: string): string | number;

Parse the draft from Draft resource.

Parameter
Name Description
draftName string

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

{string} A string representing the draft.

matchEventFromEventName(eventName)

matchEventFromEventName(eventName: string): string | number;

Parse the event from Event resource.

Parameter
Name Description
eventName string

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

{string} A string representing the event.

matchIndexEndpointFromIndexEndpointName(indexEndpointName)

matchIndexEndpointFromIndexEndpointName(indexEndpointName: string): string | number;

Parse the index_endpoint from IndexEndpoint resource.

Parameter
Name Description
indexEndpointName string

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

{string} A string representing the index_endpoint.

matchIndexFromIndexName(indexName)

matchIndexFromIndexName(indexName: string): string | number;

Parse the index from Index resource.

Parameter
Name Description
indexName string

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

{string} A string representing the index.

matchInstanceFromInstanceName(instanceName)

matchInstanceFromInstanceName(instanceName: string): string | number;

Parse the instance from Instance resource.

Parameter
Name Description
instanceName string

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

{string} A string representing the instance.

matchLocationFromAnalysisName(analysisName)

matchLocationFromAnalysisName(analysisName: string): string | number;

Parse the location from Analysis resource.

Parameter
Name Description
analysisName string

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

{string} A string representing the location.

matchLocationFromAnnotationName(annotationName)

matchLocationFromAnnotationName(annotationName: string): string | number;

Parse the location from Annotation resource.

Parameter
Name Description
annotationName string

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

{string} A string representing the location.

matchLocationFromApplicationName(applicationName)

matchLocationFromApplicationName(applicationName: string): string | number;

Parse the location from Application resource.

Parameter
Name Description
applicationName string

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

{string} A string representing the location.

matchLocationFromAssetName(assetName)

matchLocationFromAssetName(assetName: string): string | number;

Parse the location from Asset resource.

Parameter
Name Description
assetName string

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

{string} A string representing the location.

matchLocationFromChannelName(channelName)

matchLocationFromChannelName(channelName: string): string | number;

Parse the location from Channel resource.

Parameter
Name Description
channelName string

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

{string} A string representing the location.

matchLocationFromClusterName(clusterName)

matchLocationFromClusterName(clusterName: string): string | number;

Parse the location from Cluster resource.

Parameter
Name Description
clusterName string

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

{string} A string representing the location.

matchLocationFromCollectionName(collectionName)

matchLocationFromCollectionName(collectionName: string): string | number;

Parse the location from Collection resource.

Parameter
Name Description
collectionName string

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

{string} A string representing the location.

matchLocationFromCorpusName(corpusName)

matchLocationFromCorpusName(corpusName: string): string | number;

Parse the location from Corpus resource.

Parameter
Name Description
corpusName string

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

{string} A string representing the location.

matchLocationFromDataSchemaName(dataSchemaName)

matchLocationFromDataSchemaName(dataSchemaName: string): string | number;

Parse the location from DataSchema resource.

Parameter
Name Description
dataSchemaName string

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

{string} A string representing the location.

matchLocationFromDraftName(draftName)

matchLocationFromDraftName(draftName: string): string | number;

Parse the location from Draft resource.

Parameter
Name Description
draftName string

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

{string} A string representing the location.

matchLocationFromEventName(eventName)

matchLocationFromEventName(eventName: string): string | number;

Parse the location from Event resource.

Parameter
Name Description
eventName string

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

{string} A string representing the location.

matchLocationFromIndexEndpointName(indexEndpointName)

matchLocationFromIndexEndpointName(indexEndpointName: string): string | number;

Parse the location from IndexEndpoint resource.

Parameter
Name Description
indexEndpointName string

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

{string} A string representing the location.

matchLocationFromIndexName(indexName)

matchLocationFromIndexName(indexName: string): string | number;

Parse the location from Index resource.

Parameter
Name Description
indexName string

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

{string} A string representing the location.

matchLocationFromInstanceName(instanceName)

matchLocationFromInstanceName(instanceName: string): string | number;

Parse the location from Instance resource.

Parameter
Name Description
instanceName string

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

{string} A string representing the location.

matchLocationFromOperatorName(operatorName)

matchLocationFromOperatorName(operatorName: string): string | number;

Parse the location from Operator resource.

Parameter
Name Description
operatorName string

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

{string} A string representing the location.

matchLocationFromProcessName(processName)

matchLocationFromProcessName(processName: string): string | number;

Parse the location from Process resource.

Parameter
Name Description
processName string

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

{string} A string representing the location.

matchLocationFromProcessorName(processorName)

matchLocationFromProcessorName(processorName: string): string | number;

Parse the location from Processor resource.

Parameter
Name Description
processorName string

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

{string} A string representing the location.

matchLocationFromSearchConfigName(searchConfigName)

matchLocationFromSearchConfigName(searchConfigName: string): string | number;

Parse the location from SearchConfig resource.

Parameter
Name Description
searchConfigName string

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

{string} A string representing the location.

matchLocationFromSearchHypernymName(searchHypernymName)

matchLocationFromSearchHypernymName(searchHypernymName: string): string | number;

Parse the location from SearchHypernym resource.

Parameter
Name Description
searchHypernymName string

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

{string} A string representing the location.

matchLocationFromSeriesName(seriesName)

matchLocationFromSeriesName(seriesName: string): string | number;

Parse the location from Series resource.

Parameter
Name Description
seriesName string

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

{string} A string representing the location.

matchLocationFromStreamName(streamName)

matchLocationFromStreamName(streamName: string): string | number;

Parse the location from Stream resource.

Parameter
Name Description
streamName string

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

{string} A string representing the location.

matchOperatorFromOperatorName(operatorName)

matchOperatorFromOperatorName(operatorName: string): string | number;

Parse the operator from Operator resource.

Parameter
Name Description
operatorName string

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

{string} A string representing the operator.

matchProcessFromProcessName(processName)

matchProcessFromProcessName(processName: string): string | number;

Parse the process from Process resource.

Parameter
Name Description
processName string

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

{string} A string representing the process.

matchProcessorFromProcessorName(processorName)

matchProcessorFromProcessorName(processorName: string): string | number;

Parse the processor from Processor resource.

Parameter
Name Description
processorName string

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

{string} A string representing the processor.

matchProjectFromAnalysisName(analysisName)

matchProjectFromAnalysisName(analysisName: string): string | number;

Parse the project from Analysis resource.

Parameter
Name Description
analysisName string

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

{string} A string representing the project.

matchProjectFromApplicationName(applicationName)

matchProjectFromApplicationName(applicationName: string): string | number;

Parse the project from Application resource.

Parameter
Name Description
applicationName string

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

{string} A string representing the project.

matchProjectFromChannelName(channelName)

matchProjectFromChannelName(channelName: string): string | number;

Parse the project from Channel resource.

Parameter
Name Description
channelName string

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

{string} A string representing the project.

matchProjectFromClusterName(clusterName)

matchProjectFromClusterName(clusterName: string): string | number;

Parse the project from Cluster resource.

Parameter
Name Description
clusterName string

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

{string} A string representing the project.

matchProjectFromDraftName(draftName)

matchProjectFromDraftName(draftName: string): string | number;

Parse the project from Draft resource.

Parameter
Name Description
draftName string

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

{string} A string representing the project.

matchProjectFromEventName(eventName)

matchProjectFromEventName(eventName: string): string | number;

Parse the project from Event resource.

Parameter
Name Description
eventName string

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

{string} A string representing the project.

matchProjectFromIndexEndpointName(indexEndpointName)

matchProjectFromIndexEndpointName(indexEndpointName: string): string | number;

Parse the project from IndexEndpoint resource.

Parameter
Name Description
indexEndpointName string

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

{string} A string representing the project.

matchProjectFromInstanceName(instanceName)

matchProjectFromInstanceName(instanceName: string): string | number;

Parse the project from Instance resource.

Parameter
Name Description
instanceName string

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

{string} A string representing the project.

matchProjectFromOperatorName(operatorName)

matchProjectFromOperatorName(operatorName: string): string | number;

Parse the project from Operator resource.

Parameter
Name Description
operatorName string

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

{string} A string representing the project.

matchProjectFromProcessName(processName)

matchProjectFromProcessName(processName: string): string | number;

Parse the project from Process resource.

Parameter
Name Description
processName string

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

{string} A string representing the project.

matchProjectFromProcessorName(processorName)

matchProjectFromProcessorName(processorName: string): string | number;

Parse the project from Processor resource.

Parameter
Name Description
processorName string

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

{string} A string representing the project.

matchProjectFromSeriesName(seriesName)

matchProjectFromSeriesName(seriesName: string): string | number;

Parse the project from Series resource.

Parameter
Name Description
seriesName string

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

{string} A string representing the project.

matchProjectFromStreamName(streamName)

matchProjectFromStreamName(streamName: string): string | number;

Parse the project from Stream resource.

Parameter
Name Description
streamName string

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

{string} A string representing the project.

matchProjectNumberFromAnnotationName(annotationName)

matchProjectNumberFromAnnotationName(annotationName: string): string | number;

Parse the project_number from Annotation resource.

Parameter
Name Description
annotationName string

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

{string} A string representing the project_number.

matchProjectNumberFromAssetName(assetName)

matchProjectNumberFromAssetName(assetName: string): string | number;

Parse the project_number from Asset resource.

Parameter
Name Description
assetName string

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

{string} A string representing the project_number.

matchProjectNumberFromCollectionName(collectionName)

matchProjectNumberFromCollectionName(collectionName: string): string | number;

Parse the project_number from Collection resource.

Parameter
Name Description
collectionName string

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

{string} A string representing the project_number.

matchProjectNumberFromCorpusName(corpusName)

matchProjectNumberFromCorpusName(corpusName: string): string | number;

Parse the project_number from Corpus resource.

Parameter
Name Description
corpusName string

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

{string} A string representing the project_number.

matchProjectNumberFromDataSchemaName(dataSchemaName)

matchProjectNumberFromDataSchemaName(dataSchemaName: string): string | number;

Parse the project_number from DataSchema resource.

Parameter
Name Description
dataSchemaName string

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

{string} A string representing the project_number.

matchProjectNumberFromIndexName(indexName)

matchProjectNumberFromIndexName(indexName: string): string | number;

Parse the project_number from Index resource.

Parameter
Name Description
indexName string

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

{string} A string representing the project_number.

matchProjectNumberFromSearchConfigName(searchConfigName)

matchProjectNumberFromSearchConfigName(searchConfigName: string): string | number;

Parse the project_number from SearchConfig resource.

Parameter
Name Description
searchConfigName string

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

{string} A string representing the project_number.

matchProjectNumberFromSearchHypernymName(searchHypernymName)

matchProjectNumberFromSearchHypernymName(searchHypernymName: string): string | number;

Parse the project_number from SearchHypernym resource.

Parameter
Name Description
searchHypernymName string

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

{string} A string representing the project_number.

matchSearchConfigFromSearchConfigName(searchConfigName)

matchSearchConfigFromSearchConfigName(searchConfigName: string): string | number;

Parse the search_config from SearchConfig resource.

Parameter
Name Description
searchConfigName string

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

{string} A string representing the search_config.

matchSearchHypernymFromSearchHypernymName(searchHypernymName)

matchSearchHypernymFromSearchHypernymName(searchHypernymName: string): string | number;

Parse the search_hypernym from SearchHypernym resource.

Parameter
Name Description
searchHypernymName string

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

{string} A string representing the search_hypernym.

matchSeriesFromSeriesName(seriesName)

matchSeriesFromSeriesName(seriesName: string): string | number;

Parse the series from Series resource.

Parameter
Name Description
seriesName string

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

{string} A string representing the series.

matchStreamFromStreamName(streamName)

matchStreamFromStreamName(streamName: string): string | number;

Parse the stream from Stream resource.

Parameter
Name Description
streamName string

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

{string} A string representing the stream.

operatorPath(project, location, operator)

operatorPath(project: string, location: string, operator: string): string;

Return a fully-qualified operator resource name string.

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

{string} Resource name string.

processorPath(project, location, processor)

processorPath(project: string, location: string, processor: string): string;

Return a fully-qualified processor resource name string.

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

{string} Resource name string.

processPath(project, location, cluster, process)

processPath(project: string, location: string, cluster: string, process: string): string;

Return a fully-qualified process resource name string.

Parameters
Name Description
project string
location string
cluster string
process string
Returns
Type Description
string

{string} Resource name string.

searchConfigPath(projectNumber, location, corpus, searchConfig)

searchConfigPath(projectNumber: string, location: string, corpus: string, searchConfig: string): string;

Return a fully-qualified searchConfig resource name string.

Parameters
Name Description
projectNumber string
location string
corpus string
searchConfig string
Returns
Type Description
string

{string} Resource name string.

searchHypernymPath(projectNumber, location, corpus, searchHypernym)

searchHypernymPath(projectNumber: string, location: string, corpus: string, searchHypernym: string): string;

Return a fully-qualified searchHypernym resource name string.

Parameters
Name Description
projectNumber string
location string
corpus string
searchHypernym string
Returns
Type Description
string

{string} Resource name string.

seriesPath(project, location, cluster, series)

seriesPath(project: string, location: string, cluster: string, series: string): string;

Return a fully-qualified series resource name string.

Parameters
Name Description
project string
location string
cluster string
series string
Returns
Type Description
string

{string} Resource name string.

setIamPolicy(request, options, callback)

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

Returns permissions that a caller has on the specified resource. If the resource does not exist, this will return an empty set of permissions, not a NOT_FOUND error.

Note: This operation is designed to be used for building permission-aware UIs and command-line tools, not for authorization checking. This operation may "fail open" without warning.

Parameters
Name Description
request IamProtos.google.iam.v1.SetIamPolicyRequest

The request object that will be sent.
options CallOptions | Callback<google.iam.v1.Policy, google.iam.v1.SetIamPolicyRequest | null | undefined, {} | null | undefined>

Optional parameters. You can override the default settings for this call, e.g, timeout, retries, paginations, etc. See gax.CallOptions for the details.
callback Callback<google.iam.v1.Policy, google.iam.v1.SetIamPolicyRequest | null | undefined, {} | null | undefined>

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

The second parameter to the callback is an object representing .
Returns
Type Description
Promise<[google.iam.v1.Policy]>

{Promise} - The promise which resolves to an array. The first element of the array is an object representing . The promise has a method named "cancel" which cancels the ongoing API call.

streamPath(project, location, cluster, stream)

streamPath(project: string, location: string, cluster: string, stream: string): string;

Return a fully-qualified stream resource name string.

Parameters
Name Description
project string
location string
cluster string
stream string
Returns
Type Description
string

{string} Resource name string.

testIamPermissions(request, options, callback)

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

Returns permissions that a caller has on the specified resource. If the resource does not exist, this will return an empty set of permissions, not a NOT_FOUND error.

Note: This operation is designed to be used for building permission-aware UIs and command-line tools, not for authorization checking. This operation may "fail open" without warning.

Parameters
Name Description
request IamProtos.google.iam.v1.TestIamPermissionsRequest

The request object that will be sent.
options CallOptions | Callback<google.iam.v1.TestIamPermissionsResponse, google.iam.v1.TestIamPermissionsRequest | null | undefined, {} | null | undefined>

Optional parameters. You can override the default settings for this call, e.g, timeout, retries, paginations, etc. See gax.CallOptions for the details.
callback Callback<google.iam.v1.TestIamPermissionsResponse, google.iam.v1.TestIamPermissionsRequest | null | undefined, {} | null | undefined>

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

The second parameter to the callback is an object representing .
Returns
Type Description
Promise<[google.iam.v1.TestIamPermissionsResponse]>

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