Class v1beta1.LookupServiceClient (3.3.2)

Service Directory API for looking up service data at runtime. v1beta1

Package

Constructors

(constructor)(opts)

constructor(opts?: ClientOptions);

Construct an instance of LookupServiceClient.

Parameter

Name	Description
opts	`ClientOptions`

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;
    };

lookupServiceStub

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

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.

warn

warn: (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.

endpointPath(project, location, namespace, service, endpoint)

endpointPath(project: string, location: string, namespace: string, service: string, endpoint: string): string;

Return a fully-qualified endpoint resource name string.

Parameters

Name	Description
project	`string`
location	`string`
namespace	`string`
service	`string`
endpoint	`string`

Returns

Type	Description
string	{string} Resource name string.

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.

matchEndpointFromEndpointName(endpointName)

matchEndpointFromEndpointName(endpointName: string): string | number;

Parse the endpoint from Endpoint resource.

Parameter

Name	Description
endpointName	`string` A fully-qualified path representing Endpoint resource.

Returns

Type	Description
string \| number	{string} A string representing the endpoint.

matchLocationFromEndpointName(endpointName)

matchLocationFromEndpointName(endpointName: string): string | number;

Parse the location from Endpoint resource.

Parameter

Name	Description
endpointName	`string` A fully-qualified path representing Endpoint resource.

Returns

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

matchLocationFromNamespaceName(namespaceName)

matchLocationFromNamespaceName(namespaceName: string): string | number;

Parse the location from Namespace resource.

Parameter

Name	Description
namespaceName	`string` A fully-qualified path representing Namespace resource.

Returns

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

matchLocationFromServiceName(serviceName)

matchLocationFromServiceName(serviceName: string): string | number;

Parse the location from Service resource.

Parameter

Name	Description
serviceName	`string` A fully-qualified path representing Service resource.

Returns

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

matchNamespaceFromEndpointName(endpointName)

matchNamespaceFromEndpointName(endpointName: string): string | number;

Parse the namespace from Endpoint resource.

Parameter

Name	Description
endpointName	`string` A fully-qualified path representing Endpoint resource.

Returns

Type	Description
string \| number	{string} A string representing the namespace.

matchNamespaceFromNamespaceName(namespaceName)

matchNamespaceFromNamespaceName(namespaceName: string): string | number;

Parse the namespace from Namespace resource.

Parameter

Name	Description
namespaceName	`string` A fully-qualified path representing Namespace resource.

Returns

Type	Description
string \| number	{string} A string representing the namespace.

matchNamespaceFromServiceName(serviceName)

matchNamespaceFromServiceName(serviceName: string): string | number;

Parse the namespace from Service resource.

Parameter

Name	Description
serviceName	`string` A fully-qualified path representing Service resource.

Returns

Type	Description
string \| number	{string} A string representing the namespace.

matchProjectFromEndpointName(endpointName)

matchProjectFromEndpointName(endpointName: string): string | number;

Parse the project from Endpoint resource.

Parameter

Name	Description
endpointName	`string` A fully-qualified path representing Endpoint resource.

Returns

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

matchProjectFromNamespaceName(namespaceName)

matchProjectFromNamespaceName(namespaceName: string): string | number;

Parse the project from Namespace resource.

Parameter

Name	Description
namespaceName	`string` A fully-qualified path representing Namespace resource.

Returns

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

matchProjectFromServiceName(serviceName)

matchProjectFromServiceName(serviceName: string): string | number;

Parse the project from Service resource.

Parameter

Name	Description
serviceName	`string` A fully-qualified path representing Service resource.

Returns

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

matchServiceFromEndpointName(endpointName)

matchServiceFromEndpointName(endpointName: string): string | number;

Parse the service from Endpoint resource.

Parameter

Name	Description
endpointName	`string` A fully-qualified path representing Endpoint resource.

Returns

Type	Description
string \| number	{string} A string representing the service.

matchServiceFromServiceName(serviceName)

matchServiceFromServiceName(serviceName: string): string | number;

Parse the service from Service resource.

Parameter

Name	Description
serviceName	`string` A fully-qualified path representing Service resource.

Returns

Type	Description
string \| number	{string} A string representing the service.

namespacePath(project, location, namespace)

namespacePath(project: string, location: string, namespace: string): string;

Return a fully-qualified namespace resource name string.

Parameters

Name	Description
project	`string`
location	`string`
namespace	`string`

Returns

Type	Description
string	{string} Resource name string.

resolveService(request, options)

resolveService(request?: protos.google.cloud.servicedirectory.v1beta1.IResolveServiceRequest, options?: CallOptions): Promise<[protos.google.cloud.servicedirectory.v1beta1.IResolveServiceResponse, (protos.google.cloud.servicedirectory.v1beta1.IResolveServiceRequest | undefined), {} | undefined]>;

Returns a and its associated endpoints. Resolving a service is not considered an active developer method.

Parameters

Name	Description
request	`protos.google.cloud.servicedirectory.v1beta1.IResolveServiceRequest` The request object that will be sent.
options	`CallOptions` Call options. See CallOptions for more details.

Returns

Type	Description
Promise<[protos.google.cloud.servicedirectory.v1beta1.IResolveServiceResponse, (protos.google.cloud.servicedirectory.v1beta1.IResolveServiceRequest \| undefined), {} \| undefined]>	{Promise} - The promise which resolves to an array. The first element of the array is an object representing [ResolveServiceResponse]. Please see the [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#regular-methods) for more details and examples.

Example


  /**
   * TODO(developer): Uncomment these variables before running the sample.
   */
  /**
   *  Required. The name of the service to resolve.
   */
  // const name = 'abc123'
  /**
   *  Optional. The maximum number of endpoints to return. Defaults to 25. Maximum is 100.
   *  If a value less than one is specified, the Default is used.
   *  If a value greater than the Maximum is specified, the Maximum is used.
   */
  // const maxEndpoints = 1234
  /**
   *  Optional. The filter applied to the endpoints of the resolved service.
   *  General `filter` string syntax:
   *  `

resolveService(request, options, callback)

resolveService(request: protos.google.cloud.servicedirectory.v1beta1.IResolveServiceRequest, options: CallOptions, callback: Callback<protos.google.cloud.servicedirectory.v1beta1.IResolveServiceResponse, protos.google.cloud.servicedirectory.v1beta1.IResolveServiceRequest | null | undefined, {} | null | undefined>): void;

Parameters

Name	Description
request	`protos.google.cloud.servicedirectory.v1beta1.IResolveServiceRequest`
options	`CallOptions`
callback	`Callback<protos.google.cloud.servicedirectory.v1beta1.IResolveServiceResponse, protos.google.cloud.servicedirectory.v1beta1.IResolveServiceRequest \| null \| undefined, {} \| null \| undefined>`

Returns

Type	Description
void

resolveService(request, callback)

resolveService(request: protos.google.cloud.servicedirectory.v1beta1.IResolveServiceRequest, callback: Callback<protos.google.cloud.servicedirectory.v1beta1.IResolveServiceResponse, protos.google.cloud.servicedirectory.v1beta1.IResolveServiceRequest | null | undefined, {} | null | undefined>): void;

Parameters

Name	Description
request	`protos.google.cloud.servicedirectory.v1beta1.IResolveServiceRequest`
callback	`Callback<protos.google.cloud.servicedirectory.v1beta1.IResolveServiceResponse, protos.google.cloud.servicedirectory.v1beta1.IResolveServiceRequest \| null \| undefined, {} \| null \| undefined>`

Returns

Type	Description
void

servicePath(project, location, namespace, service)

servicePath(project: string, location: string, namespace: string, service: string): string;

Return a fully-qualified service resource name string.

Parameters

Name	Description
project	`string`
location	`string`
namespace	`string`
service	`string`

Returns

Type	Description
string	{string} Resource name string.