RegistrationServiceClient

RegistrationServiceClient

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

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

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

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

Constructor

new RegistrationServiceClient(optionsopt)

Construct an instance of RegistrationServiceClient.

Parameters:
Name Type Attributes Description
options object <optional>

The configuration object. See the subsequent parameters for more details.

Properties
Name Type Attributes Description
credentials object <optional>

Credentials object.

Properties
Name Type Attributes Description
client_email string <optional>
private_key string <optional>
email string <optional>

Account email address. Required when using a .pem or .p12 keyFilename.
keyFilename string <optional>

Full path to the a .json, .pem, or .p12 key downloaded from the Google Developers Console. If you provide a path to a JSON file, the projectId option below is not necessary. NOTE: .pem and .p12 require you to specify options.email as well.
port number <optional>

The port on which to connect to the remote host.
projectId string <optional>

The project ID from the Google Developer's Console, e.g. 'grape-spaceship-123'. We will also check the environment variable GCLOUD_PROJECT for your project ID. If your app is running in an environment which supports Application Default Credentials, your project ID will be detected automatically.
apiEndpoint string <optional>

The domain name of the API remote host.

Members

(static) apiEndpoint

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

(static) port

The port for this API service.

(static) scopes

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

(static) servicePath

The DNS address for this API service.

Methods

close()

Terminate the GRPC channel and close the client.

The client will no longer be usable and all future behavior is undefined.

createEndpoint(request, optionsopt) → {Promise}

Creates a endpoint, and returns the new Endpoint.

Parameters:
Name Type Attributes Description
request Object

The request object that will be sent.

Properties
Name Type Description
parent string

Required. The resource name of the service that this endpoint provides.
endpointId string

Required. The Resource ID must be 1-63 characters long, and comply with RFC1035. Specifically, the name must be 1-63 characters long and match the regular expression [a-z](?:[-a-z0-9]{0,61}[a-z0-9])? which means the first character must be a lowercase letter, and all following characters must be a dash, lowercase letter, or digit, except the last character, which cannot be a dash.
endpoint google.cloud.servicedirectory.v1beta1.Endpoint

Required. A endpoint with initial fields set.
options object <optional>

Call options. See CallOptions for more details.

createNamespace(request, optionsopt) → {Promise}

Creates a namespace, and returns the new Namespace.

Parameters:
Name Type Attributes Description
request Object

The request object that will be sent.

Properties
Name Type Description
parent string

Required. The resource name of the project and location the namespace will be created in.
namespaceId string

Required. The Resource ID must be 1-63 characters long, and comply with RFC1035. Specifically, the name must be 1-63 characters long and match the regular expression [a-z](?:[-a-z0-9]{0,61}[a-z0-9])? which means the first character must be a lowercase letter, and all following characters must be a dash, lowercase letter, or digit, except the last character, which cannot be a dash.
namespace google.cloud.servicedirectory.v1beta1.Namespace

Required. A namespace with initial fields set.
options object <optional>

Call options. See CallOptions for more details.

createService(request, optionsopt) → {Promise}

Creates a service, and returns the new Service.

Parameters:
Name Type Attributes Description
request Object

The request object that will be sent.

Properties
Name Type Description
parent string

Required. The resource name of the namespace this service will belong to.
serviceId string

Required. The Resource ID must be 1-63 characters long, and comply with RFC1035. Specifically, the name must be 1-63 characters long and match the regular expression [a-z](?:[-a-z0-9]{0,61}[a-z0-9])? which means the first character must be a lowercase letter, and all following characters must be a dash, lowercase letter, or digit, except the last character, which cannot be a dash.
service google.cloud.servicedirectory.v1beta1.Service

Required. A service with initial fields set.
options object <optional>

Call options. See CallOptions for more details.

deleteEndpoint(request, optionsopt) → {Promise}

Deletes a endpoint.

Parameters:
Name Type Attributes Description
request Object

The request object that will be sent.

Properties
Name Type Description
name string

Required. The name of the endpoint to delete.
options object <optional>

Call options. See CallOptions for more details.

deleteNamespace(request, optionsopt) → {Promise}

Deletes a namespace. This also deletes all services and endpoints in the namespace.

Parameters:
Name Type Attributes Description
request Object

The request object that will be sent.

Properties
Name Type Description
name string

Required. The name of the namespace to delete.
options object <optional>

Call options. See CallOptions for more details.

deleteService(request, optionsopt) → {Promise}

Deletes a service. This also deletes all endpoints associated with the service.

Parameters:
Name Type Attributes Description
request Object

The request object that will be sent.

Properties
Name Type Description
name string

Required. The name of the service to delete.
options object <optional>

Call options. See CallOptions for more details.

endpointPath(project, location, namespace, service, endpoint) → {string}

Return a fully-qualified endpoint resource name string.

Parameters:
Name Type Description
project string
location string
namespace string
service string
endpoint string

getEndpoint(request, optionsopt) → {Promise}

Gets a endpoint.

Parameters:
Name Type Attributes Description
request Object

The request object that will be sent.

Properties
Name Type Description
name string

Required. The name of the endpoint to get.
options object <optional>

Call options. See CallOptions for more details.

getIamPolicy(request, optionsopt) → {Promise}

Gets the IAM Policy for a resource (namespace or service only).

Parameters:
Name Type Attributes Description
request Object

The request object that will be sent.

Properties
Name Type Description
resource string

REQUIRED: The resource for which the policy is being requested. See the operation documentation for the appropriate value for this field.
options google.iam.v1.GetPolicyOptions

OPTIONAL: A GetPolicyOptions object for specifying options to GetIamPolicy. This field is only used by Cloud IAM.
options object <optional>

Call options. See CallOptions for more details.

getNamespace(request, optionsopt) → {Promise}

Gets a namespace.

Parameters:
Name Type Attributes Description
request Object

The request object that will be sent.

Properties
Name Type Description
name string

Required. The name of the namespace to retrieve.
options object <optional>

Call options. See CallOptions for more details.

getProjectId(callback)

Return the project ID used by this class.

Parameters:
Name Type Description
callback function

the callback to be called with the current project Id.

getService(request, optionsopt) → {Promise}

Gets a service.

Parameters:
Name Type Attributes Description
request Object

The request object that will be sent.

Properties
Name Type Description
name string

Required. The name of the service to get.
options object <optional>

Call options. See CallOptions for more details.

initialize() → {Promise}

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.

listEndpoints(request, optionsopt) → {Promise}

Lists all endpoints.

Parameters:
Name Type Attributes Description
request Object

The request object that will be sent.

Properties
Name Type Attributes Description
parent string

Required. The resource name of the service whose endpoints we'd like to list.
pageSize number <optional>

Optional. The maximum number of items to return.
pageToken string <optional>

Optional. The next_page_token value returned from a previous List request, if any.
filter string <optional>

Optional. The filter to list result by.

General filter string syntax: () can be "name", "address", "port" or "metadata." for map field. can be "<, >, <=, >=, !=, =, :". Of which ":" means HAS, and is roughly the same as "=". must be the same data type as field. can be "AND, OR, NOT".

Examples of valid filters:

  • "metadata.owner" returns Endpoints that have a label with the key "owner" this is the same as "metadata:owner".
  • "metadata.protocol=gRPC" returns Endpoints that have key/value "protocol=gRPC".
  • "address=192.108.1.105" returns Endpoints that have this address.
  • "port>8080" returns Endpoints that have port number larger than 8080.
  • "name>projects/my-project/locations/us-east/namespaces/my-namespace/services/my-service/endpoints/endpoint-c" returns Endpoints that have name that is alphabetically later than the string, so "endpoint-e" will be returned but "endpoint-a" will not be.
  • "metadata.owner!=sd AND metadata.foo=bar" returns Endpoints that have "owner" in label key but value is not "sd" AND have key/value foo=bar.
  • "doesnotexist.foo=bar" returns an empty list. Note that Endpoint doesn't have a field called "doesnotexist". Since the filter does not match any Endpoints, it returns no results.
orderBy string <optional>

Optional. The order to list result by.
options object <optional>

Call options. See CallOptions for more details.

listEndpointsAsync(request, optionsopt) → {Object}

Equivalent to listEndpoints, but returns an iterable object.

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

Parameters:
Name Type Attributes Description
request Object

The request object that will be sent.

Properties
Name Type Attributes Description
parent string

Required. The resource name of the service whose endpoints we'd like to list.
pageSize number <optional>

Optional. The maximum number of items to return.
pageToken string <optional>

Optional. The next_page_token value returned from a previous List request, if any.
filter string <optional>

Optional. The filter to list result by.

General filter string syntax: () can be "name", "address", "port" or "metadata." for map field. can be "<, >, <=, >=, !=, =, :". Of which ":" means HAS, and is roughly the same as "=". must be the same data type as field. can be "AND, OR, NOT".

Examples of valid filters:

  • "metadata.owner" returns Endpoints that have a label with the key "owner" this is the same as "metadata:owner".
  • "metadata.protocol=gRPC" returns Endpoints that have key/value "protocol=gRPC".
  • "address=192.108.1.105" returns Endpoints that have this address.
  • "port>8080" returns Endpoints that have port number larger than 8080.
  • "name>projects/my-project/locations/us-east/namespaces/my-namespace/services/my-service/endpoints/endpoint-c" returns Endpoints that have name that is alphabetically later than the string, so "endpoint-e" will be returned but "endpoint-a" will not be.
  • "metadata.owner!=sd AND metadata.foo=bar" returns Endpoints that have "owner" in label key but value is not "sd" AND have key/value foo=bar.
  • "doesnotexist.foo=bar" returns an empty list. Note that Endpoint doesn't have a field called "doesnotexist". Since the filter does not match any Endpoints, it returns no results.
orderBy string <optional>

Optional. The order to list result by.
options object <optional>

Call options. See CallOptions for more details.

listEndpointsStream(request, optionsopt) → {Stream}

Equivalent to listEndpoints, but returns a NodeJS Stream object.

This fetches the paged responses for listEndpoints continuously and invokes the callback registered for 'data' event for each element in the responses.

The returned object has 'end' method when no more elements are required.

autoPaginate option will be ignored.

Parameters:
Name Type Attributes Description
request Object

The request object that will be sent.

Properties
Name Type Attributes Description
parent string

Required. The resource name of the service whose endpoints we'd like to list.
pageSize number <optional>

Optional. The maximum number of items to return.
pageToken string <optional>

Optional. The next_page_token value returned from a previous List request, if any.
filter string <optional>

Optional. The filter to list result by.

General filter string syntax: () can be "name", "address", "port" or "metadata." for map field. can be "<, >, <=, >=, !=, =, :". Of which ":" means HAS, and is roughly the same as "=". must be the same data type as field. can be "AND, OR, NOT".

Examples of valid filters:

  • "metadata.owner" returns Endpoints that have a label with the key "owner" this is the same as "metadata:owner".
  • "metadata.protocol=gRPC" returns Endpoints that have key/value "protocol=gRPC".
  • "address=192.108.1.105" returns Endpoints that have this address.
  • "port>8080" returns Endpoints that have port number larger than 8080.
  • "name>projects/my-project/locations/us-east/namespaces/my-namespace/services/my-service/endpoints/endpoint-c" returns Endpoints that have name that is alphabetically later than the string, so "endpoint-e" will be returned but "endpoint-a" will not be.
  • "metadata.owner!=sd AND metadata.foo=bar" returns Endpoints that have "owner" in label key but value is not "sd" AND have key/value foo=bar.
  • "doesnotexist.foo=bar" returns an empty list. Note that Endpoint doesn't have a field called "doesnotexist". Since the filter does not match any Endpoints, it returns no results.
orderBy string <optional>

Optional. The order to list result by.
options object <optional>

Call options. See CallOptions for more details.
See:

listNamespaces(request, optionsopt) → {Promise}

Lists all namespaces.

Parameters:
Name Type Attributes Description
request Object

The request object that will be sent.

Properties
Name Type Attributes Description
parent string

Required. The resource name of the project and location whose namespaces we'd like to list.
pageSize number <optional>

Optional. The maximum number of items to return.
pageToken string <optional>

Optional. The next_page_token value returned from a previous List request, if any.
filter string <optional>

Optional. The filter to list result by.

General filter string syntax: () can be "name", or "labels." for map field. can be "<, >, <=, >=, !=, =, :". Of which ":" means HAS, and is roughly the same as "=". must be the same data type as field. can be "AND, OR, NOT".

Examples of valid filters:

  • "labels.owner" returns Namespaces that have a label with the key "owner" this is the same as "labels:owner".
  • "labels.protocol=gRPC" returns Namespaces that have key/value "protocol=gRPC".
  • "name>projects/my-project/locations/us-east/namespaces/namespace-c" returns Namespaces that have name that is alphabetically later than the string, so "namespace-e" will be returned but "namespace-a" will not be.
  • "labels.owner!=sd AND labels.foo=bar" returns Namespaces that have "owner" in label key but value is not "sd" AND have key/value foo=bar.
  • "doesnotexist.foo=bar" returns an empty list. Note that Namespace doesn't have a field called "doesnotexist". Since the filter does not match any Namespaces, it returns no results.
orderBy string <optional>

Optional. The order to list result by.

General order by string syntax: (<asc|desc>) (,) allows values {"name"} <asc/desc> ascending or descending order by . If this is left blank, "asc" is used. Note that an empty order_by string result in default order, which is order by name in ascending order.
options object <optional>

Call options. See CallOptions for more details.

listNamespacesAsync(request, optionsopt) → {Object}

Equivalent to listNamespaces, but returns an iterable object.

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

Parameters:
Name Type Attributes Description
request Object

The request object that will be sent.

Properties
Name Type Attributes Description
parent string

Required. The resource name of the project and location whose namespaces we'd like to list.
pageSize number <optional>

Optional. The maximum number of items to return.
pageToken string <optional>

Optional. The next_page_token value returned from a previous List request, if any.
filter string <optional>

Optional. The filter to list result by.

General filter string syntax: () can be "name", or "labels." for map field. can be "<, >, <=, >=, !=, =, :". Of which ":" means HAS, and is roughly the same as "=". must be the same data type as field. can be "AND, OR, NOT".

Examples of valid filters:

  • "labels.owner" returns Namespaces that have a label with the key "owner" this is the same as "labels:owner".
  • "labels.protocol=gRPC" returns Namespaces that have key/value "protocol=gRPC".
  • "name>projects/my-project/locations/us-east/namespaces/namespace-c" returns Namespaces that have name that is alphabetically later than the string, so "namespace-e" will be returned but "namespace-a" will not be.
  • "labels.owner!=sd AND labels.foo=bar" returns Namespaces that have "owner" in label key but value is not "sd" AND have key/value foo=bar.
  • "doesnotexist.foo=bar" returns an empty list. Note that Namespace doesn't have a field called "doesnotexist". Since the filter does not match any Namespaces, it returns no results.
orderBy string <optional>

Optional. The order to list result by.

General order by string syntax: (<asc|desc>) (,) allows values {"name"} <asc/desc> ascending or descending order by . If this is left blank, "asc" is used. Note that an empty order_by string result in default order, which is order by name in ascending order.
options object <optional>

Call options. See CallOptions for more details.

listNamespacesStream(request, optionsopt) → {Stream}

Equivalent to listNamespaces, but returns a NodeJS Stream object.

This fetches the paged responses for listNamespaces continuously and invokes the callback registered for 'data' event for each element in the responses.

The returned object has 'end' method when no more elements are required.

autoPaginate option will be ignored.

Parameters:
Name Type Attributes Description
request Object

The request object that will be sent.

Properties
Name Type Attributes Description
parent string

Required. The resource name of the project and location whose namespaces we'd like to list.
pageSize number <optional>

Optional. The maximum number of items to return.
pageToken string <optional>

Optional. The next_page_token value returned from a previous List request, if any.
filter string <optional>

Optional. The filter to list result by.

General filter string syntax: () can be "name", or "labels." for map field. can be "<, >, <=, >=, !=, =, :". Of which ":" means HAS, and is roughly the same as "=". must be the same data type as field. can be "AND, OR, NOT".

Examples of valid filters:

  • "labels.owner" returns Namespaces that have a label with the key "owner" this is the same as "labels:owner".
  • "labels.protocol=gRPC" returns Namespaces that have key/value "protocol=gRPC".
  • "name>projects/my-project/locations/us-east/namespaces/namespace-c" returns Namespaces that have name that is alphabetically later than the string, so "namespace-e" will be returned but "namespace-a" will not be.
  • "labels.owner!=sd AND labels.foo=bar" returns Namespaces that have "owner" in label key but value is not "sd" AND have key/value foo=bar.
  • "doesnotexist.foo=bar" returns an empty list. Note that Namespace doesn't have a field called "doesnotexist". Since the filter does not match any Namespaces, it returns no results.
orderBy string <optional>

Optional. The order to list result by.

General order by string syntax: (<asc|desc>) (,) allows values {"name"} <asc/desc> ascending or descending order by . If this is left blank, "asc" is used. Note that an empty order_by string result in default order, which is order by name in ascending order.
options object <optional>

Call options. See CallOptions for more details.
See:

listServices(request, optionsopt) → {Promise}

Lists all services belonging to a namespace.

Parameters:
Name Type Attributes Description
request Object

The request object that will be sent.

Properties
Name Type Attributes Description
parent string

Required. The resource name of the namespace whose services we'd like to list.
pageSize number <optional>

Optional. The maximum number of items to return.
pageToken string <optional>

Optional. The next_page_token value returned from a previous List request, if any.
filter string <optional>

Optional. The filter to list result by.

General filter string syntax: () can be "name", or "metadata." for map field. can be "<, >, <=, >=, !=, =, :". Of which ":" means HAS, and is roughly the same as "=". must be the same data type as field. can be "AND, OR, NOT".

Examples of valid filters:

  • "metadata.owner" returns Services that have a label with the key "owner" this is the same as "metadata:owner".
  • "metadata.protocol=gRPC" returns Services that have key/value "protocol=gRPC".
  • "name>projects/my-project/locations/us-east/namespaces/my-namespace/services/service-c" returns Services that have name that is alphabetically later than the string, so "service-e" will be returned but "service-a" will not be.
  • "metadata.owner!=sd AND metadata.foo=bar" returns Services that have "owner" in label key but value is not "sd" AND have key/value foo=bar.
  • "doesnotexist.foo=bar" returns an empty list. Note that Service doesn't have a field called "doesnotexist". Since the filter does not match any Services, it returns no results.
orderBy string <optional>

Optional. The order to list result by.
options object <optional>

Call options. See CallOptions for more details.

listServicesAsync(request, optionsopt) → {Object}

Equivalent to listServices, but returns an iterable object.

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

Parameters:
Name Type Attributes Description
request Object

The request object that will be sent.

Properties
Name Type Attributes Description
parent string

Required. The resource name of the namespace whose services we'd like to list.
pageSize number <optional>

Optional. The maximum number of items to return.
pageToken string <optional>

Optional. The next_page_token value returned from a previous List request, if any.
filter string <optional>

Optional. The filter to list result by.

General filter string syntax: () can be "name", or "metadata." for map field. can be "<, >, <=, >=, !=, =, :". Of which ":" means HAS, and is roughly the same as "=". must be the same data type as field. can be "AND, OR, NOT".

Examples of valid filters:

  • "metadata.owner" returns Services that have a label with the key "owner" this is the same as "metadata:owner".
  • "metadata.protocol=gRPC" returns Services that have key/value "protocol=gRPC".
  • "name>projects/my-project/locations/us-east/namespaces/my-namespace/services/service-c" returns Services that have name that is alphabetically later than the string, so "service-e" will be returned but "service-a" will not be.
  • "metadata.owner!=sd AND metadata.foo=bar" returns Services that have "owner" in label key but value is not "sd" AND have key/value foo=bar.
  • "doesnotexist.foo=bar" returns an empty list. Note that Service doesn't have a field called "doesnotexist". Since the filter does not match any Services, it returns no results.
orderBy string <optional>

Optional. The order to list result by.
options object <optional>

Call options. See CallOptions for more details.

listServicesStream(request, optionsopt) → {Stream}

Equivalent to listServices, but returns a NodeJS Stream object.

This fetches the paged responses for listServices continuously and invokes the callback registered for 'data' event for each element in the responses.

The returned object has 'end' method when no more elements are required.

autoPaginate option will be ignored.

Parameters:
Name Type Attributes Description
request Object

The request object that will be sent.

Properties
Name Type Attributes Description
parent string

Required. The resource name of the namespace whose services we'd like to list.
pageSize number <optional>

Optional. The maximum number of items to return.
pageToken string <optional>

Optional. The next_page_token value returned from a previous List request, if any.
filter string <optional>

Optional. The filter to list result by.

General filter string syntax: () can be "name", or "metadata." for map field. can be "<, >, <=, >=, !=, =, :". Of which ":" means HAS, and is roughly the same as "=". must be the same data type as field. can be "AND, OR, NOT".

Examples of valid filters:

  • "metadata.owner" returns Services that have a label with the key "owner" this is the same as "metadata:owner".
  • "metadata.protocol=gRPC" returns Services that have key/value "protocol=gRPC".
  • "name>projects/my-project/locations/us-east/namespaces/my-namespace/services/service-c" returns Services that have name that is alphabetically later than the string, so "service-e" will be returned but "service-a" will not be.
  • "metadata.owner!=sd AND metadata.foo=bar" returns Services that have "owner" in label key but value is not "sd" AND have key/value foo=bar.
  • "doesnotexist.foo=bar" returns an empty list. Note that Service doesn't have a field called "doesnotexist". Since the filter does not match any Services, it returns no results.
orderBy string <optional>

Optional. The order to list result by.
options object <optional>

Call options. See CallOptions for more details.
See:

locationPath(project, location) → {string}

Return a fully-qualified location resource name string.

Parameters:
Name Type Description
project string
location string

matchEndpointFromEndpointName(endpointName) → {string}

Parse the endpoint from Endpoint resource.

Parameters:
Name Type Description
endpointName string

A fully-qualified path representing Endpoint resource.

matchLocationFromEndpointName(endpointName) → {string}

Parse the location from Endpoint resource.

Parameters:
Name Type Description
endpointName string

A fully-qualified path representing Endpoint resource.

matchLocationFromLocationName(locationName) → {string}

Parse the location from Location resource.

Parameters:
Name Type Description
locationName string

A fully-qualified path representing Location resource.

matchLocationFromNamespaceName(namespaceName) → {string}

Parse the location from Namespace resource.

Parameters:
Name Type Description
namespaceName string

A fully-qualified path representing Namespace resource.

matchLocationFromServiceName(serviceName) → {string}

Parse the location from Service resource.

Parameters:
Name Type Description
serviceName string

A fully-qualified path representing Service resource.

matchNamespaceFromEndpointName(endpointName) → {string}

Parse the namespace from Endpoint resource.

Parameters:
Name Type Description
endpointName string

A fully-qualified path representing Endpoint resource.

matchNamespaceFromNamespaceName(namespaceName) → {string}

Parse the namespace from Namespace resource.

Parameters:
Name Type Description
namespaceName string

A fully-qualified path representing Namespace resource.

matchNamespaceFromServiceName(serviceName) → {string}

Parse the namespace from Service resource.

Parameters:
Name Type Description
serviceName string

A fully-qualified path representing Service resource.

matchProjectFromEndpointName(endpointName) → {string}

Parse the project from Endpoint resource.

Parameters:
Name Type Description
endpointName string

A fully-qualified path representing Endpoint resource.

matchProjectFromLocationName(locationName) → {string}

Parse the project from Location resource.

Parameters:
Name Type Description
locationName string

A fully-qualified path representing Location resource.

matchProjectFromNamespaceName(namespaceName) → {string}

Parse the project from Namespace resource.

Parameters:
Name Type Description
namespaceName string

A fully-qualified path representing Namespace resource.

matchProjectFromServiceName(serviceName) → {string}

Parse the project from Service resource.

Parameters:
Name Type Description
serviceName string

A fully-qualified path representing Service resource.

matchServiceFromEndpointName(endpointName) → {string}

Parse the service from Endpoint resource.

Parameters:
Name Type Description
endpointName string

A fully-qualified path representing Endpoint resource.

matchServiceFromServiceName(serviceName) → {string}

Parse the service from Service resource.

Parameters:
Name Type Description
serviceName string

A fully-qualified path representing Service resource.

namespacePath(project, location, namespace) → {string}

Return a fully-qualified namespace resource name string.

Parameters:
Name Type Description
project string
location string
namespace string

servicePath(project, location, namespace, service) → {string}

Return a fully-qualified service resource name string.

Parameters:
Name Type Description
project string
location string
namespace string
service string

setIamPolicy(request, optionsopt) → {Promise}

Sets the IAM Policy for a resource (namespace or service only).

Parameters:
Name Type Attributes Description
request Object

The request object that will be sent.

Properties
Name Type Description
resource string

REQUIRED: The resource for which the policy is being specified. See the operation documentation for the appropriate value for this field.
policy google.iam.v1.Policy

REQUIRED: The complete policy to be applied to the resource. The size of the policy is limited to a few 10s of KB. An empty policy is a valid policy but certain Cloud Platform services (such as Projects) might reject them.
options object <optional>

Call options. See CallOptions for more details.

testIamPermissions(request, optionsopt) → {Promise}

Tests IAM permissions for a resource (namespace or service only).

Parameters:
Name Type Attributes Description
request Object

The request object that will be sent.

Properties
Name Type Description
resource string

REQUIRED: The resource for which the policy detail is being requested. See the operation documentation for the appropriate value for this field.
permissions Array.<string>

The set of permissions to check for the resource. Permissions with wildcards (such as '' or 'storage.') are not allowed. For more information see IAM Overview.
options object <optional>

Call options. See CallOptions for more details.

updateEndpoint(request, optionsopt) → {Promise}

Updates a endpoint.

Parameters:
Name Type Attributes Description
request Object

The request object that will be sent.

Properties
Name Type Description
endpoint google.cloud.servicedirectory.v1beta1.Endpoint

Required. The updated endpoint.
updateMask google.protobuf.FieldMask

Required. List of fields to be updated in this request.
options object <optional>

Call options. See CallOptions for more details.

updateNamespace(request, optionsopt) → {Promise}

Updates a namespace.

Parameters:
Name Type Attributes Description
request Object

The request object that will be sent.

Properties
Name Type Description
namespace google.cloud.servicedirectory.v1beta1.Namespace

Required. The updated namespace.
updateMask google.protobuf.FieldMask

Required. List of fields to be updated in this request.
options object <optional>

Call options. See CallOptions for more details.

updateService(request, optionsopt) → {Promise}

Updates a service.

Parameters:
Name Type Attributes Description
request Object

The request object that will be sent.

Properties
Name Type Description
service google.cloud.servicedirectory.v1beta1.Service

Required. The updated service.
updateMask google.protobuf.FieldMask

Required. List of fields to be updated in this request.
options object <optional>

Call options. See CallOptions for more details.