Class v1.RegistrationServiceClient (3.1.2)

Service Directory API for registering services. It defines the following resource model:

  • The API has a collection of resources, named projects/* /locations/* /namespaces/*.

  • Each Namespace has a collection of resources, named projects/* /locations/* /namespaces/* /services/*.

  • Each Service has a collection of resources, named projects/* /locations/* /namespaces/* /services/* /endpoints/*. v1

Package

@google-cloud/service-directory!

Constructors

(constructor)(opts)

constructor(opts?: ClientOptions);

Construct an instance of RegistrationServiceClient.

Parameter
NameDescription
opts ClientOptions

Properties

apiEndpoint

static get apiEndpoint(): string;

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

Property Value
TypeDescription
string

auth

auth: gax.GoogleAuth;
Property Value
TypeDescription
gax.GoogleAuth

descriptors

descriptors: Descriptors;
Property Value
TypeDescription
Descriptors

innerApiCalls

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

pathTemplates

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

port

static get port(): number;

The port for this API service.

Property Value
TypeDescription
number

registrationServiceStub

registrationServiceStub?: Promise<{
        [name: string]: Function;
    }>;
Property Value
TypeDescription
Promise<{ [name: string]: Function; }>

scopes

static get scopes(): string[];

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

Property Value
TypeDescription
string[]

servicePath

static get servicePath(): string;

The DNS address for this API service.

Property Value
TypeDescription
string

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
TypeDescription
Promise<void>

{Promise} A promise that resolves when the client is closed.

createEndpoint(request, options)

createEndpoint(request: protos.google.cloud.servicedirectory.v1.ICreateEndpointRequest, options?: CallOptions): Promise<[protos.google.cloud.servicedirectory.v1.IEndpoint, (protos.google.cloud.servicedirectory.v1.ICreateEndpointRequest | undefined), {} | undefined]>;
Parameters
NameDescription
request protos.google.cloud.servicedirectory.v1.ICreateEndpointRequest
options CallOptions
Returns
TypeDescription
Promise<[protos.google.cloud.servicedirectory.v1.IEndpoint, (protos.google.cloud.servicedirectory.v1.ICreateEndpointRequest | undefined), {} | undefined]>

createEndpoint(request, options, callback)

createEndpoint(request: protos.google.cloud.servicedirectory.v1.ICreateEndpointRequest, options: CallOptions, callback: Callback<protos.google.cloud.servicedirectory.v1.IEndpoint, protos.google.cloud.servicedirectory.v1.ICreateEndpointRequest | null | undefined, {} | null | undefined>): void;
Parameters
NameDescription
request protos.google.cloud.servicedirectory.v1.ICreateEndpointRequest
options CallOptions
callback Callback<protos.google.cloud.servicedirectory.v1.IEndpoint, protos.google.cloud.servicedirectory.v1.ICreateEndpointRequest | null | undefined, {} | null | undefined>
Returns
TypeDescription
void

createEndpoint(request, callback)

createEndpoint(request: protos.google.cloud.servicedirectory.v1.ICreateEndpointRequest, callback: Callback<protos.google.cloud.servicedirectory.v1.IEndpoint, protos.google.cloud.servicedirectory.v1.ICreateEndpointRequest | null | undefined, {} | null | undefined>): void;
Parameters
NameDescription
request protos.google.cloud.servicedirectory.v1.ICreateEndpointRequest
callback Callback<protos.google.cloud.servicedirectory.v1.IEndpoint, protos.google.cloud.servicedirectory.v1.ICreateEndpointRequest | null | undefined, {} | null | undefined>
Returns
TypeDescription
void

createNamespace(request, options)

createNamespace(request: protos.google.cloud.servicedirectory.v1.ICreateNamespaceRequest, options?: CallOptions): Promise<[protos.google.cloud.servicedirectory.v1.INamespace, (protos.google.cloud.servicedirectory.v1.ICreateNamespaceRequest | undefined), {} | undefined]>;
Parameters
NameDescription
request protos.google.cloud.servicedirectory.v1.ICreateNamespaceRequest
options CallOptions
Returns
TypeDescription
Promise<[protos.google.cloud.servicedirectory.v1.INamespace, (protos.google.cloud.servicedirectory.v1.ICreateNamespaceRequest | undefined), {} | undefined]>

createNamespace(request, options, callback)

createNamespace(request: protos.google.cloud.servicedirectory.v1.ICreateNamespaceRequest, options: CallOptions, callback: Callback<protos.google.cloud.servicedirectory.v1.INamespace, protos.google.cloud.servicedirectory.v1.ICreateNamespaceRequest | null | undefined, {} | null | undefined>): void;
Parameters
NameDescription
request protos.google.cloud.servicedirectory.v1.ICreateNamespaceRequest
options CallOptions
callback Callback<protos.google.cloud.servicedirectory.v1.INamespace, protos.google.cloud.servicedirectory.v1.ICreateNamespaceRequest | null | undefined, {} | null | undefined>
Returns
TypeDescription
void

createNamespace(request, callback)

createNamespace(request: protos.google.cloud.servicedirectory.v1.ICreateNamespaceRequest, callback: Callback<protos.google.cloud.servicedirectory.v1.INamespace, protos.google.cloud.servicedirectory.v1.ICreateNamespaceRequest | null | undefined, {} | null | undefined>): void;
Parameters
NameDescription
request protos.google.cloud.servicedirectory.v1.ICreateNamespaceRequest
callback Callback<protos.google.cloud.servicedirectory.v1.INamespace, protos.google.cloud.servicedirectory.v1.ICreateNamespaceRequest | null | undefined, {} | null | undefined>
Returns
TypeDescription
void

createService(request, options)

createService(request: protos.google.cloud.servicedirectory.v1.ICreateServiceRequest, options?: CallOptions): Promise<[protos.google.cloud.servicedirectory.v1.IService, protos.google.cloud.servicedirectory.v1.ICreateServiceRequest | undefined, {} | undefined]>;
Parameters
NameDescription
request protos.google.cloud.servicedirectory.v1.ICreateServiceRequest
options CallOptions
Returns
TypeDescription
Promise<[protos.google.cloud.servicedirectory.v1.IService, protos.google.cloud.servicedirectory.v1.ICreateServiceRequest | undefined, {} | undefined]>

createService(request, options, callback)

createService(request: protos.google.cloud.servicedirectory.v1.ICreateServiceRequest, options: CallOptions, callback: Callback<protos.google.cloud.servicedirectory.v1.IService, protos.google.cloud.servicedirectory.v1.ICreateServiceRequest | null | undefined, {} | null | undefined>): void;
Parameters
NameDescription
request protos.google.cloud.servicedirectory.v1.ICreateServiceRequest
options CallOptions
callback Callback<protos.google.cloud.servicedirectory.v1.IService, protos.google.cloud.servicedirectory.v1.ICreateServiceRequest | null | undefined, {} | null | undefined>
Returns
TypeDescription
void

createService(request, callback)

createService(request: protos.google.cloud.servicedirectory.v1.ICreateServiceRequest, callback: Callback<protos.google.cloud.servicedirectory.v1.IService, protos.google.cloud.servicedirectory.v1.ICreateServiceRequest | null | undefined, {} | null | undefined>): void;
Parameters
NameDescription
request protos.google.cloud.servicedirectory.v1.ICreateServiceRequest
callback Callback<protos.google.cloud.servicedirectory.v1.IService, protos.google.cloud.servicedirectory.v1.ICreateServiceRequest | null | undefined, {} | null | undefined>
Returns
TypeDescription
void

deleteEndpoint(request, options)

deleteEndpoint(request: protos.google.cloud.servicedirectory.v1.IDeleteEndpointRequest, options?: CallOptions): Promise<[protos.google.protobuf.IEmpty, (protos.google.cloud.servicedirectory.v1.IDeleteEndpointRequest | undefined), {} | undefined]>;
Parameters
NameDescription
request protos.google.cloud.servicedirectory.v1.IDeleteEndpointRequest
options CallOptions
Returns
TypeDescription
Promise<[protos.google.protobuf.IEmpty, (protos.google.cloud.servicedirectory.v1.IDeleteEndpointRequest | undefined), {} | undefined]>

deleteEndpoint(request, options, callback)

deleteEndpoint(request: protos.google.cloud.servicedirectory.v1.IDeleteEndpointRequest, options: CallOptions, callback: Callback<protos.google.protobuf.IEmpty, protos.google.cloud.servicedirectory.v1.IDeleteEndpointRequest | null | undefined, {} | null | undefined>): void;
Parameters
NameDescription
request protos.google.cloud.servicedirectory.v1.IDeleteEndpointRequest
options CallOptions
callback Callback<protos.google.protobuf.IEmpty, protos.google.cloud.servicedirectory.v1.IDeleteEndpointRequest | null | undefined, {} | null | undefined>
Returns
TypeDescription
void

deleteEndpoint(request, callback)

deleteEndpoint(request: protos.google.cloud.servicedirectory.v1.IDeleteEndpointRequest, callback: Callback<protos.google.protobuf.IEmpty, protos.google.cloud.servicedirectory.v1.IDeleteEndpointRequest | null | undefined, {} | null | undefined>): void;
Parameters
NameDescription
request protos.google.cloud.servicedirectory.v1.IDeleteEndpointRequest
callback Callback<protos.google.protobuf.IEmpty, protos.google.cloud.servicedirectory.v1.IDeleteEndpointRequest | null | undefined, {} | null | undefined>
Returns
TypeDescription
void

deleteNamespace(request, options)

deleteNamespace(request: protos.google.cloud.servicedirectory.v1.IDeleteNamespaceRequest, options?: CallOptions): Promise<[protos.google.protobuf.IEmpty, (protos.google.cloud.servicedirectory.v1.IDeleteNamespaceRequest | undefined), {} | undefined]>;
Parameters
NameDescription
request protos.google.cloud.servicedirectory.v1.IDeleteNamespaceRequest
options CallOptions
Returns
TypeDescription
Promise<[protos.google.protobuf.IEmpty, (protos.google.cloud.servicedirectory.v1.IDeleteNamespaceRequest | undefined), {} | undefined]>

deleteNamespace(request, options, callback)

deleteNamespace(request: protos.google.cloud.servicedirectory.v1.IDeleteNamespaceRequest, options: CallOptions, callback: Callback<protos.google.protobuf.IEmpty, protos.google.cloud.servicedirectory.v1.IDeleteNamespaceRequest | null | undefined, {} | null | undefined>): void;
Parameters
NameDescription
request protos.google.cloud.servicedirectory.v1.IDeleteNamespaceRequest
options CallOptions
callback Callback<protos.google.protobuf.IEmpty, protos.google.cloud.servicedirectory.v1.IDeleteNamespaceRequest | null | undefined, {} | null | undefined>
Returns
TypeDescription
void

deleteNamespace(request, callback)

deleteNamespace(request: protos.google.cloud.servicedirectory.v1.IDeleteNamespaceRequest, callback: Callback<protos.google.protobuf.IEmpty, protos.google.cloud.servicedirectory.v1.IDeleteNamespaceRequest | null | undefined, {} | null | undefined>): void;
Parameters
NameDescription
request protos.google.cloud.servicedirectory.v1.IDeleteNamespaceRequest
callback Callback<protos.google.protobuf.IEmpty, protos.google.cloud.servicedirectory.v1.IDeleteNamespaceRequest | null | undefined, {} | null | undefined>
Returns
TypeDescription
void

deleteService(request, options)

deleteService(request: protos.google.cloud.servicedirectory.v1.IDeleteServiceRequest, options?: CallOptions): Promise<[protos.google.protobuf.IEmpty, protos.google.cloud.servicedirectory.v1.IDeleteServiceRequest | undefined, {} | undefined]>;
Parameters
NameDescription
request protos.google.cloud.servicedirectory.v1.IDeleteServiceRequest
options CallOptions
Returns
TypeDescription
Promise<[protos.google.protobuf.IEmpty, protos.google.cloud.servicedirectory.v1.IDeleteServiceRequest | undefined, {} | undefined]>

deleteService(request, options, callback)

deleteService(request: protos.google.cloud.servicedirectory.v1.IDeleteServiceRequest, options: CallOptions, callback: Callback<protos.google.protobuf.IEmpty, protos.google.cloud.servicedirectory.v1.IDeleteServiceRequest | null | undefined, {} | null | undefined>): void;
Parameters
NameDescription
request protos.google.cloud.servicedirectory.v1.IDeleteServiceRequest
options CallOptions
callback Callback<protos.google.protobuf.IEmpty, protos.google.cloud.servicedirectory.v1.IDeleteServiceRequest | null | undefined, {} | null | undefined>
Returns
TypeDescription
void

deleteService(request, callback)

deleteService(request: protos.google.cloud.servicedirectory.v1.IDeleteServiceRequest, callback: Callback<protos.google.protobuf.IEmpty, protos.google.cloud.servicedirectory.v1.IDeleteServiceRequest | null | undefined, {} | null | undefined>): void;
Parameters
NameDescription
request protos.google.cloud.servicedirectory.v1.IDeleteServiceRequest
callback Callback<protos.google.protobuf.IEmpty, protos.google.cloud.servicedirectory.v1.IDeleteServiceRequest | null | undefined, {} | null | undefined>
Returns
TypeDescription
void

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
NameDescription
project string
location string
namespace string
service string
endpoint string
Returns
TypeDescription
string

{string} Resource name string.

getEndpoint(request, options)

getEndpoint(request: protos.google.cloud.servicedirectory.v1.IGetEndpointRequest, options?: CallOptions): Promise<[protos.google.cloud.servicedirectory.v1.IEndpoint, protos.google.cloud.servicedirectory.v1.IGetEndpointRequest | undefined, {} | undefined]>;
Parameters
NameDescription
request protos.google.cloud.servicedirectory.v1.IGetEndpointRequest
options CallOptions
Returns
TypeDescription
Promise<[protos.google.cloud.servicedirectory.v1.IEndpoint, protos.google.cloud.servicedirectory.v1.IGetEndpointRequest | undefined, {} | undefined]>

getEndpoint(request, options, callback)

getEndpoint(request: protos.google.cloud.servicedirectory.v1.IGetEndpointRequest, options: CallOptions, callback: Callback<protos.google.cloud.servicedirectory.v1.IEndpoint, protos.google.cloud.servicedirectory.v1.IGetEndpointRequest | null | undefined, {} | null | undefined>): void;
Parameters
NameDescription
request protos.google.cloud.servicedirectory.v1.IGetEndpointRequest
options CallOptions
callback Callback<protos.google.cloud.servicedirectory.v1.IEndpoint, protos.google.cloud.servicedirectory.v1.IGetEndpointRequest | null | undefined, {} | null | undefined>
Returns
TypeDescription
void

getEndpoint(request, callback)

getEndpoint(request: protos.google.cloud.servicedirectory.v1.IGetEndpointRequest, callback: Callback<protos.google.cloud.servicedirectory.v1.IEndpoint, protos.google.cloud.servicedirectory.v1.IGetEndpointRequest | null | undefined, {} | null | undefined>): void;
Parameters
NameDescription
request protos.google.cloud.servicedirectory.v1.IGetEndpointRequest
callback Callback<protos.google.cloud.servicedirectory.v1.IEndpoint, protos.google.cloud.servicedirectory.v1.IGetEndpointRequest | null | undefined, {} | null | undefined>
Returns
TypeDescription
void

getIamPolicy(request, options)

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

getIamPolicy(request, options, callback)

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

getIamPolicy(request, callback)

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

getNamespace(request, options)

getNamespace(request: protos.google.cloud.servicedirectory.v1.IGetNamespaceRequest, options?: CallOptions): Promise<[protos.google.cloud.servicedirectory.v1.INamespace, protos.google.cloud.servicedirectory.v1.IGetNamespaceRequest | undefined, {} | undefined]>;
Parameters
NameDescription
request protos.google.cloud.servicedirectory.v1.IGetNamespaceRequest
options CallOptions
Returns
TypeDescription
Promise<[protos.google.cloud.servicedirectory.v1.INamespace, protos.google.cloud.servicedirectory.v1.IGetNamespaceRequest | undefined, {} | undefined]>

getNamespace(request, options, callback)

getNamespace(request: protos.google.cloud.servicedirectory.v1.IGetNamespaceRequest, options: CallOptions, callback: Callback<protos.google.cloud.servicedirectory.v1.INamespace, protos.google.cloud.servicedirectory.v1.IGetNamespaceRequest | null | undefined, {} | null | undefined>): void;
Parameters
NameDescription
request protos.google.cloud.servicedirectory.v1.IGetNamespaceRequest
options CallOptions
callback Callback<protos.google.cloud.servicedirectory.v1.INamespace, protos.google.cloud.servicedirectory.v1.IGetNamespaceRequest | null | undefined, {} | null | undefined>
Returns
TypeDescription
void

getNamespace(request, callback)

getNamespace(request: protos.google.cloud.servicedirectory.v1.IGetNamespaceRequest, callback: Callback<protos.google.cloud.servicedirectory.v1.INamespace, protos.google.cloud.servicedirectory.v1.IGetNamespaceRequest | null | undefined, {} | null | undefined>): void;
Parameters
NameDescription
request protos.google.cloud.servicedirectory.v1.IGetNamespaceRequest
callback Callback<protos.google.cloud.servicedirectory.v1.INamespace, protos.google.cloud.servicedirectory.v1.IGetNamespaceRequest | null | undefined, {} | null | undefined>
Returns
TypeDescription
void

getProjectId()

getProjectId(): Promise<string>;
Returns
TypeDescription
Promise<string>

getProjectId(callback)

getProjectId(callback: Callback<string, undefined, undefined>): void;
Parameter
NameDescription
callback Callback<string, undefined, undefined>
Returns
TypeDescription
void

getService(request, options)

getService(request: protos.google.cloud.servicedirectory.v1.IGetServiceRequest, options?: CallOptions): Promise<[protos.google.cloud.servicedirectory.v1.IService, protos.google.cloud.servicedirectory.v1.IGetServiceRequest | undefined, {} | undefined]>;
Parameters
NameDescription
request protos.google.cloud.servicedirectory.v1.IGetServiceRequest
options CallOptions
Returns
TypeDescription
Promise<[protos.google.cloud.servicedirectory.v1.IService, protos.google.cloud.servicedirectory.v1.IGetServiceRequest | undefined, {} | undefined]>

getService(request, options, callback)

getService(request: protos.google.cloud.servicedirectory.v1.IGetServiceRequest, options: CallOptions, callback: Callback<protos.google.cloud.servicedirectory.v1.IService, protos.google.cloud.servicedirectory.v1.IGetServiceRequest | null | undefined, {} | null | undefined>): void;
Parameters
NameDescription
request protos.google.cloud.servicedirectory.v1.IGetServiceRequest
options CallOptions
callback Callback<protos.google.cloud.servicedirectory.v1.IService, protos.google.cloud.servicedirectory.v1.IGetServiceRequest | null | undefined, {} | null | undefined>
Returns
TypeDescription
void

getService(request, callback)

getService(request: protos.google.cloud.servicedirectory.v1.IGetServiceRequest, callback: Callback<protos.google.cloud.servicedirectory.v1.IService, protos.google.cloud.servicedirectory.v1.IGetServiceRequest | null | undefined, {} | null | undefined>): void;
Parameters
NameDescription
request protos.google.cloud.servicedirectory.v1.IGetServiceRequest
callback Callback<protos.google.cloud.servicedirectory.v1.IService, protos.google.cloud.servicedirectory.v1.IGetServiceRequest | null | undefined, {} | null | undefined>
Returns
TypeDescription
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
TypeDescription
Promise<{ [name: string]: Function; }>

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

listEndpoints(request, options)

listEndpoints(request: protos.google.cloud.servicedirectory.v1.IListEndpointsRequest, options?: CallOptions): Promise<[protos.google.cloud.servicedirectory.v1.IEndpoint[], protos.google.cloud.servicedirectory.v1.IListEndpointsRequest | null, protos.google.cloud.servicedirectory.v1.IListEndpointsResponse]>;
Parameters
NameDescription
request protos.google.cloud.servicedirectory.v1.IListEndpointsRequest
options CallOptions
Returns
TypeDescription
Promise<[protos.google.cloud.servicedirectory.v1.IEndpoint[], protos.google.cloud.servicedirectory.v1.IListEndpointsRequest | null, protos.google.cloud.servicedirectory.v1.IListEndpointsResponse]>

listEndpoints(request, options, callback)

listEndpoints(request: protos.google.cloud.servicedirectory.v1.IListEndpointsRequest, options: CallOptions, callback: PaginationCallback<protos.google.cloud.servicedirectory.v1.IListEndpointsRequest, protos.google.cloud.servicedirectory.v1.IListEndpointsResponse | null | undefined, protos.google.cloud.servicedirectory.v1.IEndpoint>): void;
Parameters
NameDescription
request protos.google.cloud.servicedirectory.v1.IListEndpointsRequest
options CallOptions
callback PaginationCallback<protos.google.cloud.servicedirectory.v1.IListEndpointsRequest, protos.google.cloud.servicedirectory.v1.IListEndpointsResponse | null | undefined, protos.google.cloud.servicedirectory.v1.IEndpoint>
Returns
TypeDescription
void

listEndpoints(request, callback)

listEndpoints(request: protos.google.cloud.servicedirectory.v1.IListEndpointsRequest, callback: PaginationCallback<protos.google.cloud.servicedirectory.v1.IListEndpointsRequest, protos.google.cloud.servicedirectory.v1.IListEndpointsResponse | null | undefined, protos.google.cloud.servicedirectory.v1.IEndpoint>): void;
Parameters
NameDescription
request protos.google.cloud.servicedirectory.v1.IListEndpointsRequest
callback PaginationCallback<protos.google.cloud.servicedirectory.v1.IListEndpointsRequest, protos.google.cloud.servicedirectory.v1.IListEndpointsResponse | null | undefined, protos.google.cloud.servicedirectory.v1.IEndpoint>
Returns
TypeDescription
void

listEndpointsAsync(request, options)

listEndpointsAsync(request?: protos.google.cloud.servicedirectory.v1.IListEndpointsRequest, options?: CallOptions): AsyncIterable<protos.google.cloud.servicedirectory.v1.IEndpoint>;

Equivalent to listEndpoints, but returns an iterable object.

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

Parameters
NameDescription
request protos.google.cloud.servicedirectory.v1.IListEndpointsRequest

The request object that will be sent.

options CallOptions

Call options. See CallOptions for more details.

Returns
TypeDescription
AsyncIterable<protos.google.cloud.servicedirectory.v1.IEndpoint>

{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 [Endpoint]. 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.

listEndpointsStream(request, options)

listEndpointsStream(request?: protos.google.cloud.servicedirectory.v1.IListEndpointsRequest, options?: CallOptions): Transform;

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

Parameters
NameDescription
request protos.google.cloud.servicedirectory.v1.IListEndpointsRequest

The request object that will be sent.

options CallOptions

Call options. See CallOptions for more details.

Returns
TypeDescription
Transform

{Stream} An object stream which emits an object representing [Endpoint] 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 listEndpointsAsync() 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.

listNamespaces(request, options)

listNamespaces(request: protos.google.cloud.servicedirectory.v1.IListNamespacesRequest, options?: CallOptions): Promise<[protos.google.cloud.servicedirectory.v1.INamespace[], protos.google.cloud.servicedirectory.v1.IListNamespacesRequest | null, protos.google.cloud.servicedirectory.v1.IListNamespacesResponse]>;
Parameters
NameDescription
request protos.google.cloud.servicedirectory.v1.IListNamespacesRequest
options CallOptions
Returns
TypeDescription
Promise<[protos.google.cloud.servicedirectory.v1.INamespace[], protos.google.cloud.servicedirectory.v1.IListNamespacesRequest | null, protos.google.cloud.servicedirectory.v1.IListNamespacesResponse]>

listNamespaces(request, options, callback)

listNamespaces(request: protos.google.cloud.servicedirectory.v1.IListNamespacesRequest, options: CallOptions, callback: PaginationCallback<protos.google.cloud.servicedirectory.v1.IListNamespacesRequest, protos.google.cloud.servicedirectory.v1.IListNamespacesResponse | null | undefined, protos.google.cloud.servicedirectory.v1.INamespace>): void;
Parameters
NameDescription
request protos.google.cloud.servicedirectory.v1.IListNamespacesRequest
options CallOptions
callback PaginationCallback<protos.google.cloud.servicedirectory.v1.IListNamespacesRequest, protos.google.cloud.servicedirectory.v1.IListNamespacesResponse | null | undefined, protos.google.cloud.servicedirectory.v1.INamespace>
Returns
TypeDescription
void

listNamespaces(request, callback)

listNamespaces(request: protos.google.cloud.servicedirectory.v1.IListNamespacesRequest, callback: PaginationCallback<protos.google.cloud.servicedirectory.v1.IListNamespacesRequest, protos.google.cloud.servicedirectory.v1.IListNamespacesResponse | null | undefined, protos.google.cloud.servicedirectory.v1.INamespace>): void;
Parameters
NameDescription
request protos.google.cloud.servicedirectory.v1.IListNamespacesRequest
callback PaginationCallback<protos.google.cloud.servicedirectory.v1.IListNamespacesRequest, protos.google.cloud.servicedirectory.v1.IListNamespacesResponse | null | undefined, protos.google.cloud.servicedirectory.v1.INamespace>
Returns
TypeDescription
void

listNamespacesAsync(request, options)

listNamespacesAsync(request?: protos.google.cloud.servicedirectory.v1.IListNamespacesRequest, options?: CallOptions): AsyncIterable<protos.google.cloud.servicedirectory.v1.INamespace>;

Equivalent to listNamespaces, but returns an iterable object.

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

Parameters
NameDescription
request protos.google.cloud.servicedirectory.v1.IListNamespacesRequest

The request object that will be sent.

options CallOptions

Call options. See CallOptions for more details.

Returns
TypeDescription
AsyncIterable<protos.google.cloud.servicedirectory.v1.INamespace>

{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 [Namespace]. 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.

listNamespacesStream(request, options)

listNamespacesStream(request?: protos.google.cloud.servicedirectory.v1.IListNamespacesRequest, options?: CallOptions): Transform;

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

Parameters
NameDescription
request protos.google.cloud.servicedirectory.v1.IListNamespacesRequest

The request object that will be sent.

options CallOptions

Call options. See CallOptions for more details.

Returns
TypeDescription
Transform

{Stream} An object stream which emits an object representing [Namespace] 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 listNamespacesAsync() 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.

listServices(request, options)

listServices(request: protos.google.cloud.servicedirectory.v1.IListServicesRequest, options?: CallOptions): Promise<[protos.google.cloud.servicedirectory.v1.IService[], protos.google.cloud.servicedirectory.v1.IListServicesRequest | null, protos.google.cloud.servicedirectory.v1.IListServicesResponse]>;
Parameters
NameDescription
request protos.google.cloud.servicedirectory.v1.IListServicesRequest
options CallOptions
Returns
TypeDescription
Promise<[protos.google.cloud.servicedirectory.v1.IService[], protos.google.cloud.servicedirectory.v1.IListServicesRequest | null, protos.google.cloud.servicedirectory.v1.IListServicesResponse]>

listServices(request, options, callback)

listServices(request: protos.google.cloud.servicedirectory.v1.IListServicesRequest, options: CallOptions, callback: PaginationCallback<protos.google.cloud.servicedirectory.v1.IListServicesRequest, protos.google.cloud.servicedirectory.v1.IListServicesResponse | null | undefined, protos.google.cloud.servicedirectory.v1.IService>): void;
Parameters
NameDescription
request protos.google.cloud.servicedirectory.v1.IListServicesRequest
options CallOptions
callback PaginationCallback<protos.google.cloud.servicedirectory.v1.IListServicesRequest, protos.google.cloud.servicedirectory.v1.IListServicesResponse | null | undefined, protos.google.cloud.servicedirectory.v1.IService>
Returns
TypeDescription
void

listServices(request, callback)

listServices(request: protos.google.cloud.servicedirectory.v1.IListServicesRequest, callback: PaginationCallback<protos.google.cloud.servicedirectory.v1.IListServicesRequest, protos.google.cloud.servicedirectory.v1.IListServicesResponse | null | undefined, protos.google.cloud.servicedirectory.v1.IService>): void;
Parameters
NameDescription
request protos.google.cloud.servicedirectory.v1.IListServicesRequest
callback PaginationCallback<protos.google.cloud.servicedirectory.v1.IListServicesRequest, protos.google.cloud.servicedirectory.v1.IListServicesResponse | null | undefined, protos.google.cloud.servicedirectory.v1.IService>
Returns
TypeDescription
void

listServicesAsync(request, options)

listServicesAsync(request?: protos.google.cloud.servicedirectory.v1.IListServicesRequest, options?: CallOptions): AsyncIterable<protos.google.cloud.servicedirectory.v1.IService>;

Equivalent to listServices, but returns an iterable object.

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

Parameters
NameDescription
request protos.google.cloud.servicedirectory.v1.IListServicesRequest

The request object that will be sent.

options CallOptions

Call options. See CallOptions for more details.

Returns
TypeDescription
AsyncIterable<protos.google.cloud.servicedirectory.v1.IService>

{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 [Service]. 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.

listServicesStream(request, options)

listServicesStream(request?: protos.google.cloud.servicedirectory.v1.IListServicesRequest, options?: CallOptions): Transform;

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

Parameters
NameDescription
request protos.google.cloud.servicedirectory.v1.IListServicesRequest

The request object that will be sent.

options CallOptions

Call options. See CallOptions for more details.

Returns
TypeDescription
Transform

{Stream} An object stream which emits an object representing [Service] 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 listServicesAsync() 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
NameDescription
project string
location string
Returns
TypeDescription
string

{string} Resource name string.

matchEndpointFromEndpointName(endpointName)

matchEndpointFromEndpointName(endpointName: string): string | number;

Parse the endpoint from Endpoint resource.

Parameter
NameDescription
endpointName string

A fully-qualified path representing Endpoint resource.

Returns
TypeDescription
string | number

{string} A string representing the endpoint.

matchLocationFromEndpointName(endpointName)

matchLocationFromEndpointName(endpointName: string): string | number;

Parse the location from Endpoint resource.

Parameter
NameDescription
endpointName string

A fully-qualified path representing Endpoint resource.

Returns
TypeDescription
string | number

{string} A string representing the location.

matchLocationFromLocationName(locationName)

matchLocationFromLocationName(locationName: string): string | number;

Parse the location from Location resource.

Parameter
NameDescription
locationName string

A fully-qualified path representing Location resource.

Returns
TypeDescription
string | number

{string} A string representing the location.

matchLocationFromNamespaceName(namespaceName)

matchLocationFromNamespaceName(namespaceName: string): string | number;

Parse the location from Namespace resource.

Parameter
NameDescription
namespaceName string

A fully-qualified path representing Namespace resource.

Returns
TypeDescription
string | number

{string} A string representing the location.

matchLocationFromServiceName(serviceName)

matchLocationFromServiceName(serviceName: string): string | number;

Parse the location from Service resource.

Parameter
NameDescription
serviceName string

A fully-qualified path representing Service resource.

Returns
TypeDescription
string | number

{string} A string representing the location.

matchNamespaceFromEndpointName(endpointName)

matchNamespaceFromEndpointName(endpointName: string): string | number;

Parse the namespace from Endpoint resource.

Parameter
NameDescription
endpointName string

A fully-qualified path representing Endpoint resource.

Returns
TypeDescription
string | number

{string} A string representing the namespace.

matchNamespaceFromNamespaceName(namespaceName)

matchNamespaceFromNamespaceName(namespaceName: string): string | number;

Parse the namespace from Namespace resource.

Parameter
NameDescription
namespaceName string

A fully-qualified path representing Namespace resource.

Returns
TypeDescription
string | number

{string} A string representing the namespace.

matchNamespaceFromServiceName(serviceName)

matchNamespaceFromServiceName(serviceName: string): string | number;

Parse the namespace from Service resource.

Parameter
NameDescription
serviceName string

A fully-qualified path representing Service resource.

Returns
TypeDescription
string | number

{string} A string representing the namespace.

matchProjectFromEndpointName(endpointName)

matchProjectFromEndpointName(endpointName: string): string | number;

Parse the project from Endpoint resource.

Parameter
NameDescription
endpointName string

A fully-qualified path representing Endpoint resource.

Returns
TypeDescription
string | number

{string} A string representing the project.

matchProjectFromLocationName(locationName)

matchProjectFromLocationName(locationName: string): string | number;

Parse the project from Location resource.

Parameter
NameDescription
locationName string

A fully-qualified path representing Location resource.

Returns
TypeDescription
string | number

{string} A string representing the project.

matchProjectFromNamespaceName(namespaceName)

matchProjectFromNamespaceName(namespaceName: string): string | number;

Parse the project from Namespace resource.

Parameter
NameDescription
namespaceName string

A fully-qualified path representing Namespace resource.

Returns
TypeDescription
string | number

{string} A string representing the project.

matchProjectFromServiceName(serviceName)

matchProjectFromServiceName(serviceName: string): string | number;

Parse the project from Service resource.

Parameter
NameDescription
serviceName string

A fully-qualified path representing Service resource.

Returns
TypeDescription
string | number

{string} A string representing the project.

matchServiceFromEndpointName(endpointName)

matchServiceFromEndpointName(endpointName: string): string | number;

Parse the service from Endpoint resource.

Parameter
NameDescription
endpointName string

A fully-qualified path representing Endpoint resource.

Returns
TypeDescription
string | number

{string} A string representing the service.

matchServiceFromServiceName(serviceName)

matchServiceFromServiceName(serviceName: string): string | number;

Parse the service from Service resource.

Parameter
NameDescription
serviceName string

A fully-qualified path representing Service resource.

Returns
TypeDescription
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
NameDescription
project string
location string
namespace string
Returns
TypeDescription
string

{string} Resource name string.

servicePath(project, location, namespace, service)

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

Return a fully-qualified service resource name string.

Parameters
NameDescription
project string
location string
namespace string
service string
Returns
TypeDescription
string

{string} Resource name string.

setIamPolicy(request, options)

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

setIamPolicy(request, options, callback)

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

setIamPolicy(request, callback)

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

testIamPermissions(request, options)

testIamPermissions(request: protos.google.iam.v1.ITestIamPermissionsRequest, options?: CallOptions): Promise<[protos.google.iam.v1.ITestIamPermissionsResponse, protos.google.iam.v1.ITestIamPermissionsRequest | undefined, {} | undefined]>;
Parameters
NameDescription
request protos.google.iam.v1.ITestIamPermissionsRequest
options CallOptions
Returns
TypeDescription
Promise<[protos.google.iam.v1.ITestIamPermissionsResponse, protos.google.iam.v1.ITestIamPermissionsRequest | undefined, {} | undefined]>

testIamPermissions(request, options, callback)

testIamPermissions(request: protos.google.iam.v1.ITestIamPermissionsRequest, options: CallOptions, callback: Callback<protos.google.iam.v1.ITestIamPermissionsResponse, protos.google.iam.v1.ITestIamPermissionsRequest | null | undefined, {} | null | undefined>): void;
Parameters
NameDescription
request protos.google.iam.v1.ITestIamPermissionsRequest
options CallOptions
callback Callback<protos.google.iam.v1.ITestIamPermissionsResponse, protos.google.iam.v1.ITestIamPermissionsRequest | null | undefined, {} | null | undefined>
Returns
TypeDescription
void

testIamPermissions(request, callback)

testIamPermissions(request: protos.google.iam.v1.ITestIamPermissionsRequest, callback: Callback<protos.google.iam.v1.ITestIamPermissionsResponse, protos.google.iam.v1.ITestIamPermissionsRequest | null | undefined, {} | null | undefined>): void;
Parameters
NameDescription
request protos.google.iam.v1.ITestIamPermissionsRequest
callback Callback<protos.google.iam.v1.ITestIamPermissionsResponse, protos.google.iam.v1.ITestIamPermissionsRequest | null | undefined, {} | null | undefined>
Returns
TypeDescription
void

updateEndpoint(request, options)

updateEndpoint(request: protos.google.cloud.servicedirectory.v1.IUpdateEndpointRequest, options?: CallOptions): Promise<[protos.google.cloud.servicedirectory.v1.IEndpoint, (protos.google.cloud.servicedirectory.v1.IUpdateEndpointRequest | undefined), {} | undefined]>;
Parameters
NameDescription
request protos.google.cloud.servicedirectory.v1.IUpdateEndpointRequest
options CallOptions
Returns
TypeDescription
Promise<[protos.google.cloud.servicedirectory.v1.IEndpoint, (protos.google.cloud.servicedirectory.v1.IUpdateEndpointRequest | undefined), {} | undefined]>

updateEndpoint(request, options, callback)

updateEndpoint(request: protos.google.cloud.servicedirectory.v1.IUpdateEndpointRequest, options: CallOptions, callback: Callback<protos.google.cloud.servicedirectory.v1.IEndpoint, protos.google.cloud.servicedirectory.v1.IUpdateEndpointRequest | null | undefined, {} | null | undefined>): void;
Parameters
NameDescription
request protos.google.cloud.servicedirectory.v1.IUpdateEndpointRequest
options CallOptions
callback Callback<protos.google.cloud.servicedirectory.v1.IEndpoint, protos.google.cloud.servicedirectory.v1.IUpdateEndpointRequest | null | undefined, {} | null | undefined>
Returns
TypeDescription
void

updateEndpoint(request, callback)

updateEndpoint(request: protos.google.cloud.servicedirectory.v1.IUpdateEndpointRequest, callback: Callback<protos.google.cloud.servicedirectory.v1.IEndpoint, protos.google.cloud.servicedirectory.v1.IUpdateEndpointRequest | null | undefined, {} | null | undefined>): void;
Parameters
NameDescription
request protos.google.cloud.servicedirectory.v1.IUpdateEndpointRequest
callback Callback<protos.google.cloud.servicedirectory.v1.IEndpoint, protos.google.cloud.servicedirectory.v1.IUpdateEndpointRequest | null | undefined, {} | null | undefined>
Returns
TypeDescription
void

updateNamespace(request, options)

updateNamespace(request: protos.google.cloud.servicedirectory.v1.IUpdateNamespaceRequest, options?: CallOptions): Promise<[protos.google.cloud.servicedirectory.v1.INamespace, (protos.google.cloud.servicedirectory.v1.IUpdateNamespaceRequest | undefined), {} | undefined]>;
Parameters
NameDescription
request protos.google.cloud.servicedirectory.v1.IUpdateNamespaceRequest
options CallOptions
Returns
TypeDescription
Promise<[protos.google.cloud.servicedirectory.v1.INamespace, (protos.google.cloud.servicedirectory.v1.IUpdateNamespaceRequest | undefined), {} | undefined]>

updateNamespace(request, options, callback)

updateNamespace(request: protos.google.cloud.servicedirectory.v1.IUpdateNamespaceRequest, options: CallOptions, callback: Callback<protos.google.cloud.servicedirectory.v1.INamespace, protos.google.cloud.servicedirectory.v1.IUpdateNamespaceRequest | null | undefined, {} | null | undefined>): void;
Parameters
NameDescription
request protos.google.cloud.servicedirectory.v1.IUpdateNamespaceRequest
options CallOptions
callback Callback<protos.google.cloud.servicedirectory.v1.INamespace, protos.google.cloud.servicedirectory.v1.IUpdateNamespaceRequest | null | undefined, {} | null | undefined>
Returns
TypeDescription
void

updateNamespace(request, callback)

updateNamespace(request: protos.google.cloud.servicedirectory.v1.IUpdateNamespaceRequest, callback: Callback<protos.google.cloud.servicedirectory.v1.INamespace, protos.google.cloud.servicedirectory.v1.IUpdateNamespaceRequest | null | undefined, {} | null | undefined>): void;
Parameters
NameDescription
request protos.google.cloud.servicedirectory.v1.IUpdateNamespaceRequest
callback Callback<protos.google.cloud.servicedirectory.v1.INamespace, protos.google.cloud.servicedirectory.v1.IUpdateNamespaceRequest | null | undefined, {} | null | undefined>
Returns
TypeDescription
void

updateService(request, options)

updateService(request: protos.google.cloud.servicedirectory.v1.IUpdateServiceRequest, options?: CallOptions): Promise<[protos.google.cloud.servicedirectory.v1.IService, protos.google.cloud.servicedirectory.v1.IUpdateServiceRequest | undefined, {} | undefined]>;
Parameters
NameDescription
request protos.google.cloud.servicedirectory.v1.IUpdateServiceRequest
options CallOptions
Returns
TypeDescription
Promise<[protos.google.cloud.servicedirectory.v1.IService, protos.google.cloud.servicedirectory.v1.IUpdateServiceRequest | undefined, {} | undefined]>

updateService(request, options, callback)

updateService(request: protos.google.cloud.servicedirectory.v1.IUpdateServiceRequest, options: CallOptions, callback: Callback<protos.google.cloud.servicedirectory.v1.IService, protos.google.cloud.servicedirectory.v1.IUpdateServiceRequest | null | undefined, {} | null | undefined>): void;
Parameters
NameDescription
request protos.google.cloud.servicedirectory.v1.IUpdateServiceRequest
options CallOptions
callback Callback<protos.google.cloud.servicedirectory.v1.IService, protos.google.cloud.servicedirectory.v1.IUpdateServiceRequest | null | undefined, {} | null | undefined>
Returns
TypeDescription
void

updateService(request, callback)

updateService(request: protos.google.cloud.servicedirectory.v1.IUpdateServiceRequest, callback: Callback<protos.google.cloud.servicedirectory.v1.IService, protos.google.cloud.servicedirectory.v1.IUpdateServiceRequest | null | undefined, {} | null | undefined>): void;
Parameters
NameDescription
request protos.google.cloud.servicedirectory.v1.IUpdateServiceRequest
callback Callback<protos.google.cloud.servicedirectory.v1.IService, protos.google.cloud.servicedirectory.v1.IUpdateServiceRequest | null | undefined, {} | null | undefined>
Returns
TypeDescription
void