Class v1p1beta1.AdaptationClient (4.7.0)

Service that implements Google Cloud Speech Adaptation API. v1p1beta1

Package

@google-cloud/speech!

Constructors

(constructor)(opts)

constructor(opts?: ClientOptions);

Construct an instance of AdaptationClient.

Parameter
Name Description
opts ClientOptions

Properties

adaptationStub

adaptationStub?: Promise<{
        [name: string]: Function;
    }>;
Property Value
Type Description
Promise<{ [name: string]: Function; }>

apiEndpoint

static get apiEndpoint(): string;

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

Property Value
Type Description
string

auth

auth: gax.GoogleAuth;
Property Value
Type Description
gax.GoogleAuth

descriptors

descriptors: Descriptors;
Property Value
Type Description
Descriptors

innerApiCalls

innerApiCalls: {
        [name: string]: Function;
    };
Property Value
Type Description
{ [name: string]: Function; }

pathTemplates

pathTemplates: {
        [name: string]: gax.PathTemplate;
    };
Property Value
Type Description
{ [name: string]: gax.PathTemplate; }

port

static get port(): number;

The port for this API service.

Property Value
Type Description
number

scopes

static get scopes(): string[];

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

Property Value
Type Description
string[]

servicePath

static get servicePath(): string;

The DNS address for this API service.

Property Value
Type Description
string

warn

warn: (code: string, message: string, warnType?: string) => void;
Property Value
Type Description
(code: string, message: string, warnType?: string) => void

Methods

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.

createCustomClass(request, options)

createCustomClass(request?: protos.google.cloud.speech.v1p1beta1.ICreateCustomClassRequest, options?: CallOptions): Promise<[protos.google.cloud.speech.v1p1beta1.ICustomClass, (protos.google.cloud.speech.v1p1beta1.ICreateCustomClassRequest | undefined), {} | undefined]>;
Parameters
Name Description
request protos.google.cloud.speech.v1p1beta1.ICreateCustomClassRequest
options CallOptions
Returns
Type Description
Promise<[protos.google.cloud.speech.v1p1beta1.ICustomClass, (protos.google.cloud.speech.v1p1beta1.ICreateCustomClassRequest | undefined), {} | undefined]>

createCustomClass(request, options, callback)

createCustomClass(request: protos.google.cloud.speech.v1p1beta1.ICreateCustomClassRequest, options: CallOptions, callback: Callback<protos.google.cloud.speech.v1p1beta1.ICustomClass, protos.google.cloud.speech.v1p1beta1.ICreateCustomClassRequest | null | undefined, {} | null | undefined>): void;
Parameters
Name Description
request protos.google.cloud.speech.v1p1beta1.ICreateCustomClassRequest
options CallOptions
callback Callback<protos.google.cloud.speech.v1p1beta1.ICustomClass, protos.google.cloud.speech.v1p1beta1.ICreateCustomClassRequest | null | undefined, {} | null | undefined>
Returns
Type Description
void

createCustomClass(request, callback)

createCustomClass(request: protos.google.cloud.speech.v1p1beta1.ICreateCustomClassRequest, callback: Callback<protos.google.cloud.speech.v1p1beta1.ICustomClass, protos.google.cloud.speech.v1p1beta1.ICreateCustomClassRequest | null | undefined, {} | null | undefined>): void;
Parameters
Name Description
request protos.google.cloud.speech.v1p1beta1.ICreateCustomClassRequest
callback Callback<protos.google.cloud.speech.v1p1beta1.ICustomClass, protos.google.cloud.speech.v1p1beta1.ICreateCustomClassRequest | null | undefined, {} | null | undefined>
Returns
Type Description
void

createPhraseSet(request, options)

createPhraseSet(request?: protos.google.cloud.speech.v1p1beta1.ICreatePhraseSetRequest, options?: CallOptions): Promise<[protos.google.cloud.speech.v1p1beta1.IPhraseSet, protos.google.cloud.speech.v1p1beta1.ICreatePhraseSetRequest | undefined, {} | undefined]>;
Parameters
Name Description
request protos.google.cloud.speech.v1p1beta1.ICreatePhraseSetRequest
options CallOptions
Returns
Type Description
Promise<[protos.google.cloud.speech.v1p1beta1.IPhraseSet, protos.google.cloud.speech.v1p1beta1.ICreatePhraseSetRequest | undefined, {} | undefined]>

createPhraseSet(request, options, callback)

createPhraseSet(request: protos.google.cloud.speech.v1p1beta1.ICreatePhraseSetRequest, options: CallOptions, callback: Callback<protos.google.cloud.speech.v1p1beta1.IPhraseSet, protos.google.cloud.speech.v1p1beta1.ICreatePhraseSetRequest | null | undefined, {} | null | undefined>): void;
Parameters
Name Description
request protos.google.cloud.speech.v1p1beta1.ICreatePhraseSetRequest
options CallOptions
callback Callback<protos.google.cloud.speech.v1p1beta1.IPhraseSet, protos.google.cloud.speech.v1p1beta1.ICreatePhraseSetRequest | null | undefined, {} | null | undefined>
Returns
Type Description
void

createPhraseSet(request, callback)

createPhraseSet(request: protos.google.cloud.speech.v1p1beta1.ICreatePhraseSetRequest, callback: Callback<protos.google.cloud.speech.v1p1beta1.IPhraseSet, protos.google.cloud.speech.v1p1beta1.ICreatePhraseSetRequest | null | undefined, {} | null | undefined>): void;
Parameters
Name Description
request protos.google.cloud.speech.v1p1beta1.ICreatePhraseSetRequest
callback Callback<protos.google.cloud.speech.v1p1beta1.IPhraseSet, protos.google.cloud.speech.v1p1beta1.ICreatePhraseSetRequest | null | undefined, {} | null | undefined>
Returns
Type Description
void

customClassPath(project, location, customClass)

customClassPath(project: string, location: string, customClass: string): string;

Return a fully-qualified customClass resource name string.

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

{string} Resource name string.

deleteCustomClass(request, options)

deleteCustomClass(request?: protos.google.cloud.speech.v1p1beta1.IDeleteCustomClassRequest, options?: CallOptions): Promise<[protos.google.protobuf.IEmpty, (protos.google.cloud.speech.v1p1beta1.IDeleteCustomClassRequest | undefined), {} | undefined]>;
Parameters
Name Description
request protos.google.cloud.speech.v1p1beta1.IDeleteCustomClassRequest
options CallOptions
Returns
Type Description
Promise<[protos.google.protobuf.IEmpty, (protos.google.cloud.speech.v1p1beta1.IDeleteCustomClassRequest | undefined), {} | undefined]>

deleteCustomClass(request, options, callback)

deleteCustomClass(request: protos.google.cloud.speech.v1p1beta1.IDeleteCustomClassRequest, options: CallOptions, callback: Callback<protos.google.protobuf.IEmpty, protos.google.cloud.speech.v1p1beta1.IDeleteCustomClassRequest | null | undefined, {} | null | undefined>): void;
Parameters
Name Description
request protos.google.cloud.speech.v1p1beta1.IDeleteCustomClassRequest
options CallOptions
callback Callback<protos.google.protobuf.IEmpty, protos.google.cloud.speech.v1p1beta1.IDeleteCustomClassRequest | null | undefined, {} | null | undefined>
Returns
Type Description
void

deleteCustomClass(request, callback)

deleteCustomClass(request: protos.google.cloud.speech.v1p1beta1.IDeleteCustomClassRequest, callback: Callback<protos.google.protobuf.IEmpty, protos.google.cloud.speech.v1p1beta1.IDeleteCustomClassRequest | null | undefined, {} | null | undefined>): void;
Parameters
Name Description
request protos.google.cloud.speech.v1p1beta1.IDeleteCustomClassRequest
callback Callback<protos.google.protobuf.IEmpty, protos.google.cloud.speech.v1p1beta1.IDeleteCustomClassRequest | null | undefined, {} | null | undefined>
Returns
Type Description
void

deletePhraseSet(request, options)

deletePhraseSet(request?: protos.google.cloud.speech.v1p1beta1.IDeletePhraseSetRequest, options?: CallOptions): Promise<[protos.google.protobuf.IEmpty, protos.google.cloud.speech.v1p1beta1.IDeletePhraseSetRequest | undefined, {} | undefined]>;
Parameters
Name Description
request protos.google.cloud.speech.v1p1beta1.IDeletePhraseSetRequest
options CallOptions
Returns
Type Description
Promise<[protos.google.protobuf.IEmpty, protos.google.cloud.speech.v1p1beta1.IDeletePhraseSetRequest | undefined, {} | undefined]>

deletePhraseSet(request, options, callback)

deletePhraseSet(request: protos.google.cloud.speech.v1p1beta1.IDeletePhraseSetRequest, options: CallOptions, callback: Callback<protos.google.protobuf.IEmpty, protos.google.cloud.speech.v1p1beta1.IDeletePhraseSetRequest | null | undefined, {} | null | undefined>): void;
Parameters
Name Description
request protos.google.cloud.speech.v1p1beta1.IDeletePhraseSetRequest
options CallOptions
callback Callback<protos.google.protobuf.IEmpty, protos.google.cloud.speech.v1p1beta1.IDeletePhraseSetRequest | null | undefined, {} | null | undefined>
Returns
Type Description
void

deletePhraseSet(request, callback)

deletePhraseSet(request: protos.google.cloud.speech.v1p1beta1.IDeletePhraseSetRequest, callback: Callback<protos.google.protobuf.IEmpty, protos.google.cloud.speech.v1p1beta1.IDeletePhraseSetRequest | null | undefined, {} | null | undefined>): void;
Parameters
Name Description
request protos.google.cloud.speech.v1p1beta1.IDeletePhraseSetRequest
callback Callback<protos.google.protobuf.IEmpty, protos.google.cloud.speech.v1p1beta1.IDeletePhraseSetRequest | null | undefined, {} | null | undefined>
Returns
Type Description
void

getCustomClass(request, options)

getCustomClass(request?: protos.google.cloud.speech.v1p1beta1.IGetCustomClassRequest, options?: CallOptions): Promise<[protos.google.cloud.speech.v1p1beta1.ICustomClass, protos.google.cloud.speech.v1p1beta1.IGetCustomClassRequest | undefined, {} | undefined]>;
Parameters
Name Description
request protos.google.cloud.speech.v1p1beta1.IGetCustomClassRequest
options CallOptions
Returns
Type Description
Promise<[protos.google.cloud.speech.v1p1beta1.ICustomClass, protos.google.cloud.speech.v1p1beta1.IGetCustomClassRequest | undefined, {} | undefined]>

getCustomClass(request, options, callback)

getCustomClass(request: protos.google.cloud.speech.v1p1beta1.IGetCustomClassRequest, options: CallOptions, callback: Callback<protos.google.cloud.speech.v1p1beta1.ICustomClass, protos.google.cloud.speech.v1p1beta1.IGetCustomClassRequest | null | undefined, {} | null | undefined>): void;
Parameters
Name Description
request protos.google.cloud.speech.v1p1beta1.IGetCustomClassRequest
options CallOptions
callback Callback<protos.google.cloud.speech.v1p1beta1.ICustomClass, protos.google.cloud.speech.v1p1beta1.IGetCustomClassRequest | null | undefined, {} | null | undefined>
Returns
Type Description
void

getCustomClass(request, callback)

getCustomClass(request: protos.google.cloud.speech.v1p1beta1.IGetCustomClassRequest, callback: Callback<protos.google.cloud.speech.v1p1beta1.ICustomClass, protos.google.cloud.speech.v1p1beta1.IGetCustomClassRequest | null | undefined, {} | null | undefined>): void;
Parameters
Name Description
request protos.google.cloud.speech.v1p1beta1.IGetCustomClassRequest
callback Callback<protos.google.cloud.speech.v1p1beta1.ICustomClass, protos.google.cloud.speech.v1p1beta1.IGetCustomClassRequest | null | undefined, {} | null | undefined>
Returns
Type Description
void

getPhraseSet(request, options)

getPhraseSet(request?: protos.google.cloud.speech.v1p1beta1.IGetPhraseSetRequest, options?: CallOptions): Promise<[protos.google.cloud.speech.v1p1beta1.IPhraseSet, protos.google.cloud.speech.v1p1beta1.IGetPhraseSetRequest | undefined, {} | undefined]>;
Parameters
Name Description
request protos.google.cloud.speech.v1p1beta1.IGetPhraseSetRequest
options CallOptions
Returns
Type Description
Promise<[protos.google.cloud.speech.v1p1beta1.IPhraseSet, protos.google.cloud.speech.v1p1beta1.IGetPhraseSetRequest | undefined, {} | undefined]>

getPhraseSet(request, options, callback)

getPhraseSet(request: protos.google.cloud.speech.v1p1beta1.IGetPhraseSetRequest, options: CallOptions, callback: Callback<protos.google.cloud.speech.v1p1beta1.IPhraseSet, protos.google.cloud.speech.v1p1beta1.IGetPhraseSetRequest | null | undefined, {} | null | undefined>): void;
Parameters
Name Description
request protos.google.cloud.speech.v1p1beta1.IGetPhraseSetRequest
options CallOptions
callback Callback<protos.google.cloud.speech.v1p1beta1.IPhraseSet, protos.google.cloud.speech.v1p1beta1.IGetPhraseSetRequest | null | undefined, {} | null | undefined>
Returns
Type Description
void

getPhraseSet(request, callback)

getPhraseSet(request: protos.google.cloud.speech.v1p1beta1.IGetPhraseSetRequest, callback: Callback<protos.google.cloud.speech.v1p1beta1.IPhraseSet, protos.google.cloud.speech.v1p1beta1.IGetPhraseSetRequest | null | undefined, {} | null | undefined>): void;
Parameters
Name Description
request protos.google.cloud.speech.v1p1beta1.IGetPhraseSetRequest
callback Callback<protos.google.cloud.speech.v1p1beta1.IPhraseSet, protos.google.cloud.speech.v1p1beta1.IGetPhraseSetRequest | null | undefined, {} | null | undefined>
Returns
Type Description
void

getProjectId()

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

getProjectId(callback)

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

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.

listCustomClasses(request, options)

listCustomClasses(request?: protos.google.cloud.speech.v1p1beta1.IListCustomClassesRequest, options?: CallOptions): Promise<[protos.google.cloud.speech.v1p1beta1.ICustomClass[], protos.google.cloud.speech.v1p1beta1.IListCustomClassesRequest | null, protos.google.cloud.speech.v1p1beta1.IListCustomClassesResponse]>;
Parameters
Name Description
request protos.google.cloud.speech.v1p1beta1.IListCustomClassesRequest
options CallOptions
Returns
Type Description
Promise<[protos.google.cloud.speech.v1p1beta1.ICustomClass[], protos.google.cloud.speech.v1p1beta1.IListCustomClassesRequest | null, protos.google.cloud.speech.v1p1beta1.IListCustomClassesResponse]>

listCustomClasses(request, options, callback)

listCustomClasses(request: protos.google.cloud.speech.v1p1beta1.IListCustomClassesRequest, options: CallOptions, callback: PaginationCallback<protos.google.cloud.speech.v1p1beta1.IListCustomClassesRequest, protos.google.cloud.speech.v1p1beta1.IListCustomClassesResponse | null | undefined, protos.google.cloud.speech.v1p1beta1.ICustomClass>): void;
Parameters
Name Description
request protos.google.cloud.speech.v1p1beta1.IListCustomClassesRequest
options CallOptions
callback PaginationCallback<protos.google.cloud.speech.v1p1beta1.IListCustomClassesRequest, protos.google.cloud.speech.v1p1beta1.IListCustomClassesResponse | null | undefined, protos.google.cloud.speech.v1p1beta1.ICustomClass>
Returns
Type Description
void

listCustomClasses(request, callback)

listCustomClasses(request: protos.google.cloud.speech.v1p1beta1.IListCustomClassesRequest, callback: PaginationCallback<protos.google.cloud.speech.v1p1beta1.IListCustomClassesRequest, protos.google.cloud.speech.v1p1beta1.IListCustomClassesResponse | null | undefined, protos.google.cloud.speech.v1p1beta1.ICustomClass>): void;
Parameters
Name Description
request protos.google.cloud.speech.v1p1beta1.IListCustomClassesRequest
callback PaginationCallback<protos.google.cloud.speech.v1p1beta1.IListCustomClassesRequest, protos.google.cloud.speech.v1p1beta1.IListCustomClassesResponse | null | undefined, protos.google.cloud.speech.v1p1beta1.ICustomClass>
Returns
Type Description
void

listCustomClassesAsync(request, options)

listCustomClassesAsync(request?: protos.google.cloud.speech.v1p1beta1.IListCustomClassesRequest, options?: CallOptions): AsyncIterable<protos.google.cloud.speech.v1p1beta1.ICustomClass>;

Equivalent to listCustomClasses, but returns an iterable object.

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

Parameters
Name Description
request protos.google.cloud.speech.v1p1beta1.IListCustomClassesRequest

The request object that will be sent.
options CallOptions

Call options. See CallOptions for more details.
Returns
Type Description
AsyncIterable<protos.google.cloud.speech.v1p1beta1.ICustomClass>

{Object} An iterable Object that allows [async iteration](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Iteration_protocols). When you iterate the returned iterable, each element will be an object representing [CustomClass]. 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](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination) for more details and examples.

listCustomClassesStream(request, options)

listCustomClassesStream(request?: protos.google.cloud.speech.v1p1beta1.IListCustomClassesRequest, options?: CallOptions): Transform;

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

Parameters
Name Description
request protos.google.cloud.speech.v1p1beta1.IListCustomClassesRequest

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 [CustomClass] 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 listCustomClassesAsync() method described below for async iteration which you can stop as needed. Please see the [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination) for more details and examples.

listPhraseSet(request, options)

listPhraseSet(request?: protos.google.cloud.speech.v1p1beta1.IListPhraseSetRequest, options?: CallOptions): Promise<[protos.google.cloud.speech.v1p1beta1.IPhraseSet[], protos.google.cloud.speech.v1p1beta1.IListPhraseSetRequest | null, protos.google.cloud.speech.v1p1beta1.IListPhraseSetResponse]>;
Parameters
Name Description
request protos.google.cloud.speech.v1p1beta1.IListPhraseSetRequest
options CallOptions
Returns
Type Description
Promise<[protos.google.cloud.speech.v1p1beta1.IPhraseSet[], protos.google.cloud.speech.v1p1beta1.IListPhraseSetRequest | null, protos.google.cloud.speech.v1p1beta1.IListPhraseSetResponse]>

listPhraseSet(request, options, callback)

listPhraseSet(request: protos.google.cloud.speech.v1p1beta1.IListPhraseSetRequest, options: CallOptions, callback: PaginationCallback<protos.google.cloud.speech.v1p1beta1.IListPhraseSetRequest, protos.google.cloud.speech.v1p1beta1.IListPhraseSetResponse | null | undefined, protos.google.cloud.speech.v1p1beta1.IPhraseSet>): void;
Parameters
Name Description
request protos.google.cloud.speech.v1p1beta1.IListPhraseSetRequest
options CallOptions
callback PaginationCallback<protos.google.cloud.speech.v1p1beta1.IListPhraseSetRequest, protos.google.cloud.speech.v1p1beta1.IListPhraseSetResponse | null | undefined, protos.google.cloud.speech.v1p1beta1.IPhraseSet>
Returns
Type Description
void

listPhraseSet(request, callback)

listPhraseSet(request: protos.google.cloud.speech.v1p1beta1.IListPhraseSetRequest, callback: PaginationCallback<protos.google.cloud.speech.v1p1beta1.IListPhraseSetRequest, protos.google.cloud.speech.v1p1beta1.IListPhraseSetResponse | null | undefined, protos.google.cloud.speech.v1p1beta1.IPhraseSet>): void;
Parameters
Name Description
request protos.google.cloud.speech.v1p1beta1.IListPhraseSetRequest
callback PaginationCallback<protos.google.cloud.speech.v1p1beta1.IListPhraseSetRequest, protos.google.cloud.speech.v1p1beta1.IListPhraseSetResponse | null | undefined, protos.google.cloud.speech.v1p1beta1.IPhraseSet>
Returns
Type Description
void

listPhraseSetAsync(request, options)

listPhraseSetAsync(request?: protos.google.cloud.speech.v1p1beta1.IListPhraseSetRequest, options?: CallOptions): AsyncIterable<protos.google.cloud.speech.v1p1beta1.IPhraseSet>;

Equivalent to listPhraseSet, but returns an iterable object.

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

Parameters
Name Description
request protos.google.cloud.speech.v1p1beta1.IListPhraseSetRequest

The request object that will be sent.
options CallOptions

Call options. See CallOptions for more details.
Returns
Type Description
AsyncIterable<protos.google.cloud.speech.v1p1beta1.IPhraseSet>

{Object} An iterable Object that allows [async iteration](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Iteration_protocols). When you iterate the returned iterable, each element will be an object representing [PhraseSet]. 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](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination) for more details and examples.

listPhraseSetStream(request, options)

listPhraseSetStream(request?: protos.google.cloud.speech.v1p1beta1.IListPhraseSetRequest, options?: CallOptions): Transform;

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

Parameters
Name Description
request protos.google.cloud.speech.v1p1beta1.IListPhraseSetRequest

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 [PhraseSet] 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 listPhraseSetAsync() method described below for async iteration which you can stop as needed. Please see the [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination) for more details and examples.

locationPath(project, location)

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

Return a fully-qualified location resource name string.

Parameters
Name Description
project string
location string
Returns
Type Description
string

{string} Resource name string.

matchCustomClassFromCustomClassName(customClassName)

matchCustomClassFromCustomClassName(customClassName: string): string | number;

Parse the custom_class from CustomClass resource.

Parameter
Name Description
customClassName string

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

{string} A string representing the custom_class.

matchLocationFromCustomClassName(customClassName)

matchLocationFromCustomClassName(customClassName: string): string | number;

Parse the location from CustomClass resource.

Parameter
Name Description
customClassName string

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

{string} A string representing the location.

matchLocationFromLocationName(locationName)

matchLocationFromLocationName(locationName: string): string | number;

Parse the location from Location resource.

Parameter
Name Description
locationName string

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

{string} A string representing the location.

matchLocationFromPhraseSetName(phraseSetName)

matchLocationFromPhraseSetName(phraseSetName: string): string | number;

Parse the location from PhraseSet resource.

Parameter
Name Description
phraseSetName string

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

{string} A string representing the location.

matchPhraseSetFromPhraseSetName(phraseSetName)

matchPhraseSetFromPhraseSetName(phraseSetName: string): string | number;

Parse the phrase_set from PhraseSet resource.

Parameter
Name Description
phraseSetName string

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

{string} A string representing the phrase_set.

matchProjectFromCustomClassName(customClassName)

matchProjectFromCustomClassName(customClassName: string): string | number;

Parse the project from CustomClass resource.

Parameter
Name Description
customClassName string

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

{string} A string representing the project.

matchProjectFromLocationName(locationName)

matchProjectFromLocationName(locationName: string): string | number;

Parse the project from Location resource.

Parameter
Name Description
locationName string

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

{string} A string representing the project.

matchProjectFromPhraseSetName(phraseSetName)

matchProjectFromPhraseSetName(phraseSetName: string): string | number;

Parse the project from PhraseSet resource.

Parameter
Name Description
phraseSetName string

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

{string} A string representing the project.

matchProjectFromProjectName(projectName)

matchProjectFromProjectName(projectName: string): string | number;

Parse the project from Project resource.

Parameter
Name Description
projectName string

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

{string} A string representing the project.

phraseSetPath(project, location, phraseSet)

phraseSetPath(project: string, location: string, phraseSet: string): string;

Return a fully-qualified phraseSet resource name string.

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

{string} Resource name string.

projectPath(project)

projectPath(project: string): string;

Return a fully-qualified project resource name string.

Parameter
Name Description
project string
Returns
Type Description
string

{string} Resource name string.

updateCustomClass(request, options)

updateCustomClass(request?: protos.google.cloud.speech.v1p1beta1.IUpdateCustomClassRequest, options?: CallOptions): Promise<[protos.google.cloud.speech.v1p1beta1.ICustomClass, (protos.google.cloud.speech.v1p1beta1.IUpdateCustomClassRequest | undefined), {} | undefined]>;
Parameters
Name Description
request protos.google.cloud.speech.v1p1beta1.IUpdateCustomClassRequest
options CallOptions
Returns
Type Description
Promise<[protos.google.cloud.speech.v1p1beta1.ICustomClass, (protos.google.cloud.speech.v1p1beta1.IUpdateCustomClassRequest | undefined), {} | undefined]>

updateCustomClass(request, options, callback)

updateCustomClass(request: protos.google.cloud.speech.v1p1beta1.IUpdateCustomClassRequest, options: CallOptions, callback: Callback<protos.google.cloud.speech.v1p1beta1.ICustomClass, protos.google.cloud.speech.v1p1beta1.IUpdateCustomClassRequest | null | undefined, {} | null | undefined>): void;
Parameters
Name Description
request protos.google.cloud.speech.v1p1beta1.IUpdateCustomClassRequest
options CallOptions
callback Callback<protos.google.cloud.speech.v1p1beta1.ICustomClass, protos.google.cloud.speech.v1p1beta1.IUpdateCustomClassRequest | null | undefined, {} | null | undefined>
Returns
Type Description
void

updateCustomClass(request, callback)

updateCustomClass(request: protos.google.cloud.speech.v1p1beta1.IUpdateCustomClassRequest, callback: Callback<protos.google.cloud.speech.v1p1beta1.ICustomClass, protos.google.cloud.speech.v1p1beta1.IUpdateCustomClassRequest | null | undefined, {} | null | undefined>): void;
Parameters
Name Description
request protos.google.cloud.speech.v1p1beta1.IUpdateCustomClassRequest
callback Callback<protos.google.cloud.speech.v1p1beta1.ICustomClass, protos.google.cloud.speech.v1p1beta1.IUpdateCustomClassRequest | null | undefined, {} | null | undefined>
Returns
Type Description
void

updatePhraseSet(request, options)

updatePhraseSet(request?: protos.google.cloud.speech.v1p1beta1.IUpdatePhraseSetRequest, options?: CallOptions): Promise<[protos.google.cloud.speech.v1p1beta1.IPhraseSet, protos.google.cloud.speech.v1p1beta1.IUpdatePhraseSetRequest | undefined, {} | undefined]>;
Parameters
Name Description
request protos.google.cloud.speech.v1p1beta1.IUpdatePhraseSetRequest
options CallOptions
Returns
Type Description
Promise<[protos.google.cloud.speech.v1p1beta1.IPhraseSet, protos.google.cloud.speech.v1p1beta1.IUpdatePhraseSetRequest | undefined, {} | undefined]>

updatePhraseSet(request, options, callback)

updatePhraseSet(request: protos.google.cloud.speech.v1p1beta1.IUpdatePhraseSetRequest, options: CallOptions, callback: Callback<protos.google.cloud.speech.v1p1beta1.IPhraseSet, protos.google.cloud.speech.v1p1beta1.IUpdatePhraseSetRequest | null | undefined, {} | null | undefined>): void;
Parameters
Name Description
request protos.google.cloud.speech.v1p1beta1.IUpdatePhraseSetRequest
options CallOptions
callback Callback<protos.google.cloud.speech.v1p1beta1.IPhraseSet, protos.google.cloud.speech.v1p1beta1.IUpdatePhraseSetRequest | null | undefined, {} | null | undefined>
Returns
Type Description
void

updatePhraseSet(request, callback)

updatePhraseSet(request: protos.google.cloud.speech.v1p1beta1.IUpdatePhraseSetRequest, callback: Callback<protos.google.cloud.speech.v1p1beta1.IPhraseSet, protos.google.cloud.speech.v1p1beta1.IUpdatePhraseSetRequest | null | undefined, {} | null | undefined>): void;
Parameters
Name Description
request protos.google.cloud.speech.v1p1beta1.IUpdatePhraseSetRequest
callback Callback<protos.google.cloud.speech.v1p1beta1.IPhraseSet, protos.google.cloud.speech.v1p1beta1.IUpdatePhraseSetRequest | null | undefined, {} | null | undefined>
Returns
Type Description
void