Google Cloud Service Directory V1 Client - Class RegistrationServiceClient (1.2.1)

Version 1.2.1

• 2.0.1 (latest)
• 2.0.0
• 1.3.6
• 1.2.1
• 1.1.2
• 1.0.5

Beta

This library is covered by the Pre-GA Offerings Terms of the Terms of Service. Pre-GA libraries might have limited support, and changes to pre-GA libraries might not be compatible with other pre-GA versions. For more information, see the launch stage descriptions.

Reference documentation and code samples for the Google Cloud Service Directory V1 Client class RegistrationServiceClient.

Service Description: 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/*.

This class provides the ability to make remote calls to the backing service through method calls that map to API methods.

Many parameters require resource names to be formatted in a particular way. To assist with these names, this class includes a format method for each type of name, and additionally a parseName method to extract the individual identifiers contained within formatted names that are returned by the API.

This class is currently experimental and may be subject to changes. See Google\Cloud\ServiceDirectory\V1\RegistrationServiceClient for the stable implementation

Namespace

Google \ Cloud \ ServiceDirectory \ V1 \ Client

Methods

__construct

Constructor.

Parameters
Name	Description
options	array Optional. Options for configuring the service API wrapper.
↳ apiEndpoint	string The address of the API remote host. May optionally include the port, formatted as "
↳ credentials	string|array|FetchAuthTokenInterface|CredentialsWrapper The credentials to be used by the client to authorize API calls. This option accepts either a path to a credentials file, or a decoded credentials file as a PHP array. Advanced usage: In addition, this option can also accept a pre-constructed Google\Auth\FetchAuthTokenInterface object or Google\ApiCore\CredentialsWrapper object. Note that when one of these objects are provided, any settings in $credentialsConfig will be ignored.
↳ credentialsConfig	array Options used to configure credentials, including auth token caching, for the client. For a full list of supporting configuration options, see Google\ApiCore\CredentialsWrapper::build() .
↳ disableRetries	bool Determines whether or not retries defined by the client configuration should be disabled. Defaults to false.
↳ clientConfig	string|array Client method configuration, including retry settings. This option can be either a path to a JSON file, or a PHP array containing the decoded JSON data. By default this settings points to the default client config file, which is provided in the resources folder.
↳ transport	string|TransportInterface The transport used for executing network requests. May be either the string rest or grpc. Defaults to grpc if gRPC support is detected on the system. Advanced usage: Additionally, it is possible to pass in an already instantiated Google\ApiCore\Transport\TransportInterface object. Note that when this object is provided, any settings in $transportConfig, and any $apiEndpoint setting, will be ignored.
↳ transportConfig	array Configuration options that will be used to construct the transport. Options for each supported transport type should be passed in a key for that transport. For example: $transportConfig = [ 'grpc' => [...], 'rest' => [...], ]; See the Google\ApiCore\Transport\GrpcTransport::build() and Google\ApiCore\Transport\RestTransport::build() methods for the supported options.
↳ clientCertSource	callable A callable which returns the client cert as a string. This can be used to provide a certificate and private key to the transport layer for mTLS.

createEndpoint

Creates an endpoint, and returns the new endpoint.

The async variant is Google\Cloud\ServiceDirectory\V1\Client\RegistrationServiceClient::createEndpointAsync() .

Parameters
Name	Description
request	Google\Cloud\ServiceDirectory\V1\CreateEndpointRequest A request to house fields associated with the call.
callOptions	array Optional.
↳ retrySettings	RetrySettings|array Retry settings to use for this call. Can be a Google\ApiCore\RetrySettings object, or an associative array of retry settings parameters. See the documentation on Google\ApiCore\RetrySettings for example usage.

Returns
Type	Description
Google\Cloud\ServiceDirectory\V1\Endpoint

createNamespace

Creates a namespace, and returns the new namespace.

The async variant is Google\Cloud\ServiceDirectory\V1\Client\RegistrationServiceClient::createNamespaceAsync() .

Parameters
Name	Description
request	Google\Cloud\ServiceDirectory\V1\CreateNamespaceRequest A request to house fields associated with the call.
callOptions	array Optional.
↳ retrySettings	RetrySettings|array Retry settings to use for this call. Can be a Google\ApiCore\RetrySettings object, or an associative array of retry settings parameters. See the documentation on Google\ApiCore\RetrySettings for example usage.

Returns
Type	Description
Google\Cloud\ServiceDirectory\V1\PBNamespace

createService

Creates a service, and returns the new service.

The async variant is Google\Cloud\ServiceDirectory\V1\Client\RegistrationServiceClient::createServiceAsync() .

Parameters
Name	Description
request	Google\Cloud\ServiceDirectory\V1\CreateServiceRequest A request to house fields associated with the call.
callOptions	array Optional.
↳ retrySettings	RetrySettings|array Retry settings to use for this call. Can be a Google\ApiCore\RetrySettings object, or an associative array of retry settings parameters. See the documentation on Google\ApiCore\RetrySettings for example usage.

Returns
Type	Description
Google\Cloud\ServiceDirectory\V1\Service

deleteEndpoint

Deletes an endpoint.

The async variant is Google\Cloud\ServiceDirectory\V1\Client\RegistrationServiceClient::deleteEndpointAsync() .

Parameters
Name	Description
request	Google\Cloud\ServiceDirectory\V1\DeleteEndpointRequest A request to house fields associated with the call.
callOptions	array Optional.
↳ retrySettings	RetrySettings|array Retry settings to use for this call. Can be a Google\ApiCore\RetrySettings object, or an associative array of retry settings parameters. See the documentation on Google\ApiCore\RetrySettings for example usage.

deleteNamespace

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

The async variant is Google\Cloud\ServiceDirectory\V1\Client\RegistrationServiceClient::deleteNamespaceAsync() .

Parameters
Name	Description
request	Google\Cloud\ServiceDirectory\V1\DeleteNamespaceRequest A request to house fields associated with the call.
callOptions	array Optional.
↳ retrySettings	RetrySettings|array Retry settings to use for this call. Can be a Google\ApiCore\RetrySettings object, or an associative array of retry settings parameters. See the documentation on Google\ApiCore\RetrySettings for example usage.

deleteService

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

The async variant is Google\Cloud\ServiceDirectory\V1\Client\RegistrationServiceClient::deleteServiceAsync() .

Parameters
Name	Description
request	Google\Cloud\ServiceDirectory\V1\DeleteServiceRequest A request to house fields associated with the call.
callOptions	array Optional.
↳ retrySettings	RetrySettings|array Retry settings to use for this call. Can be a Google\ApiCore\RetrySettings object, or an associative array of retry settings parameters. See the documentation on Google\ApiCore\RetrySettings for example usage.

getEndpoint

Gets an endpoint.

The async variant is Google\Cloud\ServiceDirectory\V1\Client\RegistrationServiceClient::getEndpointAsync() .

Parameters
Name	Description
request	Google\Cloud\ServiceDirectory\V1\GetEndpointRequest A request to house fields associated with the call.
callOptions	array Optional.
↳ retrySettings	RetrySettings|array Retry settings to use for this call. Can be a Google\ApiCore\RetrySettings object, or an associative array of retry settings parameters. See the documentation on Google\ApiCore\RetrySettings for example usage.

Returns
Type	Description
Google\Cloud\ServiceDirectory\V1\Endpoint

getIamPolicy

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

The async variant is Google\Cloud\ServiceDirectory\V1\Client\RegistrationServiceClient::getIamPolicyAsync() .

Parameters
Name	Description
request	Google\Cloud\Iam\V1\GetIamPolicyRequest A request to house fields associated with the call.
callOptions	array Optional.
↳ retrySettings	RetrySettings|array Retry settings to use for this call. Can be a Google\ApiCore\RetrySettings object, or an associative array of retry settings parameters. See the documentation on Google\ApiCore\RetrySettings for example usage.

Returns
Type	Description
Google\Cloud\Iam\V1\Policy

getNamespace

Gets a namespace.

The async variant is Google\Cloud\ServiceDirectory\V1\Client\RegistrationServiceClient::getNamespaceAsync() .

Parameters
Name	Description
request	Google\Cloud\ServiceDirectory\V1\GetNamespaceRequest A request to house fields associated with the call.
callOptions	array Optional.
↳ retrySettings	RetrySettings|array Retry settings to use for this call. Can be a Google\ApiCore\RetrySettings object, or an associative array of retry settings parameters. See the documentation on Google\ApiCore\RetrySettings for example usage.

Returns
Type	Description
Google\Cloud\ServiceDirectory\V1\PBNamespace

getService

Gets a service.

The async variant is Google\Cloud\ServiceDirectory\V1\Client\RegistrationServiceClient::getServiceAsync() .

Parameters
Name	Description
request	Google\Cloud\ServiceDirectory\V1\GetServiceRequest A request to house fields associated with the call.
callOptions	array Optional.
↳ retrySettings	RetrySettings|array Retry settings to use for this call. Can be a Google\ApiCore\RetrySettings object, or an associative array of retry settings parameters. See the documentation on Google\ApiCore\RetrySettings for example usage.

Returns
Type	Description
Google\Cloud\ServiceDirectory\V1\Service

listEndpoints

Lists all endpoints.

The async variant is Google\Cloud\ServiceDirectory\V1\Client\RegistrationServiceClient::listEndpointsAsync() .

Parameters
Name	Description
request	Google\Cloud\ServiceDirectory\V1\ListEndpointsRequest A request to house fields associated with the call.
callOptions	array Optional.
↳ retrySettings	RetrySettings|array Retry settings to use for this call. Can be a Google\ApiCore\RetrySettings object, or an associative array of retry settings parameters. See the documentation on Google\ApiCore\RetrySettings for example usage.

Returns
Type	Description
Google\ApiCore\PagedListResponse

listNamespaces

Lists all namespaces.

The async variant is Google\Cloud\ServiceDirectory\V1\Client\RegistrationServiceClient::listNamespacesAsync() .

Parameters
Name	Description
request	Google\Cloud\ServiceDirectory\V1\ListNamespacesRequest A request to house fields associated with the call.
callOptions	array Optional.
↳ retrySettings	RetrySettings|array Retry settings to use for this call. Can be a Google\ApiCore\RetrySettings object, or an associative array of retry settings parameters. See the documentation on Google\ApiCore\RetrySettings for example usage.

Returns
Type	Description
Google\ApiCore\PagedListResponse

listServices

Lists all services belonging to a namespace.

The async variant is Google\Cloud\ServiceDirectory\V1\Client\RegistrationServiceClient::listServicesAsync() .

Parameters
Name	Description
request	Google\Cloud\ServiceDirectory\V1\ListServicesRequest A request to house fields associated with the call.
callOptions	array Optional.
↳ retrySettings	RetrySettings|array Retry settings to use for this call. Can be a Google\ApiCore\RetrySettings object, or an associative array of retry settings parameters. See the documentation on Google\ApiCore\RetrySettings for example usage.

Returns
Type	Description
Google\ApiCore\PagedListResponse

setIamPolicy

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

The async variant is Google\Cloud\ServiceDirectory\V1\Client\RegistrationServiceClient::setIamPolicyAsync() .

Parameters
Name	Description
request	Google\Cloud\Iam\V1\SetIamPolicyRequest A request to house fields associated with the call.
callOptions	array Optional.
↳ retrySettings	RetrySettings|array Retry settings to use for this call. Can be a Google\ApiCore\RetrySettings object, or an associative array of retry settings parameters. See the documentation on Google\ApiCore\RetrySettings for example usage.

Returns
Type	Description
Google\Cloud\Iam\V1\Policy

testIamPermissions

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

The async variant is Google\Cloud\ServiceDirectory\V1\Client\RegistrationServiceClient::testIamPermissionsAsync() .

Parameters
Name	Description
request	Google\Cloud\Iam\V1\TestIamPermissionsRequest A request to house fields associated with the call.
callOptions	array Optional.
↳ retrySettings	RetrySettings|array Retry settings to use for this call. Can be a Google\ApiCore\RetrySettings object, or an associative array of retry settings parameters. See the documentation on Google\ApiCore\RetrySettings for example usage.

Returns
Type	Description
Google\Cloud\Iam\V1\TestIamPermissionsResponse

updateEndpoint

Updates an endpoint.

The async variant is Google\Cloud\ServiceDirectory\V1\Client\RegistrationServiceClient::updateEndpointAsync() .

Parameters
Name	Description
request	Google\Cloud\ServiceDirectory\V1\UpdateEndpointRequest A request to house fields associated with the call.
callOptions	array Optional.
↳ retrySettings	RetrySettings|array Retry settings to use for this call. Can be a Google\ApiCore\RetrySettings object, or an associative array of retry settings parameters. See the documentation on Google\ApiCore\RetrySettings for example usage.

Returns
Type	Description
Google\Cloud\ServiceDirectory\V1\Endpoint

updateNamespace

Updates a namespace.

The async variant is Google\Cloud\ServiceDirectory\V1\Client\RegistrationServiceClient::updateNamespaceAsync() .

Parameters
Name	Description
request	Google\Cloud\ServiceDirectory\V1\UpdateNamespaceRequest A request to house fields associated with the call.
callOptions	array Optional.
↳ retrySettings	RetrySettings|array Retry settings to use for this call. Can be a Google\ApiCore\RetrySettings object, or an associative array of retry settings parameters. See the documentation on Google\ApiCore\RetrySettings for example usage.

Returns
Type	Description
Google\Cloud\ServiceDirectory\V1\PBNamespace

updateService

Updates a service.

The async variant is Google\Cloud\ServiceDirectory\V1\Client\RegistrationServiceClient::updateServiceAsync() .

Parameters
Name	Description
request	Google\Cloud\ServiceDirectory\V1\UpdateServiceRequest A request to house fields associated with the call.
callOptions	array Optional.
↳ retrySettings	RetrySettings|array Retry settings to use for this call. Can be a Google\ApiCore\RetrySettings object, or an associative array of retry settings parameters. See the documentation on Google\ApiCore\RetrySettings for example usage.

Returns
Type	Description
Google\Cloud\ServiceDirectory\V1\Service

getLocation

Gets information about a location.

The async variant is Google\Cloud\ServiceDirectory\V1\Client\RegistrationServiceClient::getLocationAsync() .

Parameters
Name	Description
request	Google\Cloud\Location\GetLocationRequest A request to house fields associated with the call.
callOptions	array Optional.
↳ retrySettings	RetrySettings|array Retry settings to use for this call. Can be a Google\ApiCore\RetrySettings object, or an associative array of retry settings parameters. See the documentation on Google\ApiCore\RetrySettings for example usage.

Returns
Type	Description
Google\Cloud\Location\Location

listLocations

Lists information about the supported locations for this service.

The async variant is Google\Cloud\ServiceDirectory\V1\Client\RegistrationServiceClient::listLocationsAsync() .

Parameters
Name	Description
request	Google\Cloud\Location\ListLocationsRequest A request to house fields associated with the call.
callOptions	array Optional.
↳ retrySettings	RetrySettings|array Retry settings to use for this call. Can be a Google\ApiCore\RetrySettings object, or an associative array of retry settings parameters. See the documentation on Google\ApiCore\RetrySettings for example usage.

Returns
Type	Description
Google\ApiCore\PagedListResponse

createEndpointAsync

Parameters
Name	Description
request	Google\Cloud\ServiceDirectory\V1\CreateEndpointRequest
optionalArgs = []	array

Returns
Type	Description
GuzzleHttp\Promise\PromiseInterface

createNamespaceAsync

Parameters
Name	Description
request	Google\Cloud\ServiceDirectory\V1\CreateNamespaceRequest
optionalArgs = []	array

Returns
Type	Description
GuzzleHttp\Promise\PromiseInterface

createServiceAsync

Parameters
Name	Description
request	Google\Cloud\ServiceDirectory\V1\CreateServiceRequest
optionalArgs = []	array

Returns
Type	Description
GuzzleHttp\Promise\PromiseInterface

deleteEndpointAsync

Parameters
Name	Description
request	Google\Cloud\ServiceDirectory\V1\DeleteEndpointRequest
optionalArgs = []	array

Returns
Type	Description
GuzzleHttp\Promise\PromiseInterface

deleteNamespaceAsync

Parameters
Name	Description
request	Google\Cloud\ServiceDirectory\V1\DeleteNamespaceRequest
optionalArgs = []	array

Returns
Type	Description
GuzzleHttp\Promise\PromiseInterface

deleteServiceAsync

Parameters
Name	Description
request	Google\Cloud\ServiceDirectory\V1\DeleteServiceRequest
optionalArgs = []	array

Returns
Type	Description
GuzzleHttp\Promise\PromiseInterface

getEndpointAsync

Parameters
Name	Description
request	Google\Cloud\ServiceDirectory\V1\GetEndpointRequest
optionalArgs = []	array

Returns
Type	Description
GuzzleHttp\Promise\PromiseInterface

getIamPolicyAsync

Parameters
Name	Description
request	Google\Cloud\Iam\V1\GetIamPolicyRequest
optionalArgs = []	array

Returns
Type	Description
GuzzleHttp\Promise\PromiseInterface

getNamespaceAsync

Parameters
Name	Description
request	Google\Cloud\ServiceDirectory\V1\GetNamespaceRequest
optionalArgs = []	array

Returns
Type	Description
GuzzleHttp\Promise\PromiseInterface

getServiceAsync

Parameters
Name	Description
request	Google\Cloud\ServiceDirectory\V1\GetServiceRequest
optionalArgs = []	array

Returns
Type	Description
GuzzleHttp\Promise\PromiseInterface

listEndpointsAsync

Parameters
Name	Description
request	Google\Cloud\ServiceDirectory\V1\ListEndpointsRequest
optionalArgs = []	array

Returns
Type	Description
GuzzleHttp\Promise\PromiseInterface

listNamespacesAsync

Parameters
Name	Description
request	Google\Cloud\ServiceDirectory\V1\ListNamespacesRequest
optionalArgs = []	array

Returns
Type	Description
GuzzleHttp\Promise\PromiseInterface

listServicesAsync

Parameters
Name	Description
request	Google\Cloud\ServiceDirectory\V1\ListServicesRequest
optionalArgs = []	array

Returns
Type	Description
GuzzleHttp\Promise\PromiseInterface

setIamPolicyAsync

Parameters
Name	Description
request	Google\Cloud\Iam\V1\SetIamPolicyRequest
optionalArgs = []	array

Returns
Type	Description
GuzzleHttp\Promise\PromiseInterface

testIamPermissionsAsync

Parameters
Name	Description
request	Google\Cloud\Iam\V1\TestIamPermissionsRequest
optionalArgs = []	array

Returns
Type	Description
GuzzleHttp\Promise\PromiseInterface

updateEndpointAsync

Parameters
Name	Description
request	Google\Cloud\ServiceDirectory\V1\UpdateEndpointRequest
optionalArgs = []	array

Returns
Type	Description
GuzzleHttp\Promise\PromiseInterface

updateNamespaceAsync

Parameters
Name	Description
request	Google\Cloud\ServiceDirectory\V1\UpdateNamespaceRequest
optionalArgs = []	array

Returns
Type	Description
GuzzleHttp\Promise\PromiseInterface

updateServiceAsync

Parameters
Name	Description
request	Google\Cloud\ServiceDirectory\V1\UpdateServiceRequest
optionalArgs = []	array

Returns
Type	Description
GuzzleHttp\Promise\PromiseInterface

getLocationAsync

Parameters
Name	Description
request	Google\Cloud\Location\GetLocationRequest
optionalArgs = []	array

Returns
Type	Description
GuzzleHttp\Promise\PromiseInterface

listLocationsAsync

Parameters
Name	Description
request	Google\Cloud\Location\ListLocationsRequest
optionalArgs = []	array

Returns
Type	Description
GuzzleHttp\Promise\PromiseInterface

static::endpointName

Formats a string containing the fully-qualified path to represent a endpoint resource.

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

Returns
Type	Description
string	The formatted endpoint resource.

static::locationName

Formats a string containing the fully-qualified path to represent a location resource.

Parameters
Name	Description
project	string
location	string

Returns
Type	Description
string	The formatted location resource.

static::namespaceName

Formats a string containing the fully-qualified path to represent a namespace resource.

Parameters
Name	Description
project	string
location	string
namespace	string

Returns
Type	Description
string	The formatted namespace resource.

static::networkName

Formats a string containing the fully-qualified path to represent a network resource.

Parameters
Name	Description
project	string
network	string

Returns
Type	Description
string	The formatted network resource.

static::serviceName

Formats a string containing the fully-qualified path to represent a service resource.

Parameters
Name	Description
project	string
location	string
namespace	string
service	string

Returns
Type	Description
string	The formatted service resource.

static::parseName

Parses a formatted name string and returns an associative array of the components in the name.

The following name formats are supported: Template: Pattern

• endpoint: projects/{project}/locations/{location}/namespaces/{namespace}/services/{service}/endpoints/{endpoint}
• location: projects/{project}/locations/{location}
• namespace: projects/{project}/locations/{location}/namespaces/{namespace}
• network: projects/{project}/locations/global/networks/{network}
• service: projects/{project}/locations/{location}/namespaces/{namespace}/services/{service}

The optional $template argument can be supplied to specify a particular pattern, and must match one of the templates listed above. If no $template argument is provided, or if the $template argument does not match one of the templates listed, then parseName will check each of the supported templates, and return the first match.

Parameters
Name	Description
formattedName	string The formatted name string
template	string Optional name of template to match

Returns
Type	Description
array	An associative array from name component IDs to component values.