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

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.

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
Example 
use Google\ApiCore\ApiException;
use Google\Cloud\ServiceDirectory\V1\Client\RegistrationServiceClient;
use Google\Cloud\ServiceDirectory\V1\CreateEndpointRequest;
use Google\Cloud\ServiceDirectory\V1\Endpoint;

/**
 * @param string $formattedParent The resource name of the service that this endpoint provides. Please see
 *                                {@see RegistrationServiceClient::serviceName()} for help formatting this field.
 * @param string $endpointId      The Resource ID must be 1-63 characters long, and comply with
 *                                <a href="https://www.ietf.org/rfc/rfc1035.txt" target="_blank">RFC1035</a>.
 *                                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.
 */
function create_endpoint_sample(string $formattedParent, string $endpointId): void
{
    // Create a client.
    $registrationServiceClient = new RegistrationServiceClient();

    // Prepare the request message.
    $endpoint = new Endpoint();
    $request = (new CreateEndpointRequest())
        ->setParent($formattedParent)
        ->setEndpointId($endpointId)
        ->setEndpoint($endpoint);

    // Call the API and handle any network failures.
    try {
        /** @var Endpoint $response */
        $response = $registrationServiceClient->createEndpoint($request);
        printf('Response data: %s' . PHP_EOL, $response->serializeToJsonString());
    } catch (ApiException $ex) {
        printf('Call failed with message: %s' . PHP_EOL, $ex->getMessage());
    }
}

/**
 * Helper to execute the sample.
 *
 * This sample has been automatically generated and should be regarded as a code
 * template only. It will require modifications to work:
 *  - It may require correct/in-range values for request initialization.
 *  - It may require specifying regional endpoints when creating the service client,
 *    please see the apiEndpoint client configuration option for more details.
 */
function callSample(): void
{
    $formattedParent = RegistrationServiceClient::serviceName(
        '[PROJECT]',
        '[LOCATION]',
        '[NAMESPACE]',
        '[SERVICE]'
    );
    $endpointId = '[ENDPOINT_ID]';

    create_endpoint_sample($formattedParent, $endpointId);
}

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
Example 
use Google\ApiCore\ApiException;
use Google\Cloud\ServiceDirectory\V1\Client\RegistrationServiceClient;
use Google\Cloud\ServiceDirectory\V1\CreateNamespaceRequest;
use Google\Cloud\ServiceDirectory\V1\PBNamespace;

/**
 * @param string $formattedParent The resource name of the project and location the namespace
 *                                will be created in. Please see
 *                                {@see RegistrationServiceClient::locationName()} for help formatting this field.
 * @param string $namespaceId     The Resource ID must be 1-63 characters long, and comply with
 *                                <a href="https://www.ietf.org/rfc/rfc1035.txt" target="_blank">RFC1035</a>.
 *                                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.
 */
function create_namespace_sample(string $formattedParent, string $namespaceId): void
{
    // Create a client.
    $registrationServiceClient = new RegistrationServiceClient();

    // Prepare the request message.
    $namespace = new PBNamespace();
    $request = (new CreateNamespaceRequest())
        ->setParent($formattedParent)
        ->setNamespaceId($namespaceId)
        ->setNamespace($namespace);

    // Call the API and handle any network failures.
    try {
        /** @var PBNamespace $response */
        $response = $registrationServiceClient->createNamespace($request);
        printf('Response data: %s' . PHP_EOL, $response->serializeToJsonString());
    } catch (ApiException $ex) {
        printf('Call failed with message: %s' . PHP_EOL, $ex->getMessage());
    }
}

/**
 * Helper to execute the sample.
 *
 * This sample has been automatically generated and should be regarded as a code
 * template only. It will require modifications to work:
 *  - It may require correct/in-range values for request initialization.
 *  - It may require specifying regional endpoints when creating the service client,
 *    please see the apiEndpoint client configuration option for more details.
 */
function callSample(): void
{
    $formattedParent = RegistrationServiceClient::locationName('[PROJECT]', '[LOCATION]');
    $namespaceId = '[NAMESPACE_ID]';

    create_namespace_sample($formattedParent, $namespaceId);
}

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
Example 
use Google\ApiCore\ApiException;
use Google\Cloud\ServiceDirectory\V1\Client\RegistrationServiceClient;
use Google\Cloud\ServiceDirectory\V1\CreateServiceRequest;
use Google\Cloud\ServiceDirectory\V1\Service;

/**
 * @param string $formattedParent The resource name of the namespace this service will belong to. Please see
 *                                {@see RegistrationServiceClient::namespaceName()} for help formatting this field.
 * @param string $serviceId       The Resource ID must be 1-63 characters long, and comply with
 *                                <a href="https://www.ietf.org/rfc/rfc1035.txt" target="_blank">RFC1035</a>.
 *                                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.
 */
function create_service_sample(string $formattedParent, string $serviceId): void
{
    // Create a client.
    $registrationServiceClient = new RegistrationServiceClient();

    // Prepare the request message.
    $service = new Service();
    $request = (new CreateServiceRequest())
        ->setParent($formattedParent)
        ->setServiceId($serviceId)
        ->setService($service);

    // Call the API and handle any network failures.
    try {
        /** @var Service $response */
        $response = $registrationServiceClient->createService($request);
        printf('Response data: %s' . PHP_EOL, $response->serializeToJsonString());
    } catch (ApiException $ex) {
        printf('Call failed with message: %s' . PHP_EOL, $ex->getMessage());
    }
}

/**
 * Helper to execute the sample.
 *
 * This sample has been automatically generated and should be regarded as a code
 * template only. It will require modifications to work:
 *  - It may require correct/in-range values for request initialization.
 *  - It may require specifying regional endpoints when creating the service client,
 *    please see the apiEndpoint client configuration option for more details.
 */
function callSample(): void
{
    $formattedParent = RegistrationServiceClient::namespaceName(
        '[PROJECT]',
        '[LOCATION]',
        '[NAMESPACE]'
    );
    $serviceId = '[SERVICE_ID]';

    create_service_sample($formattedParent, $serviceId);
}

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.
Example 
use Google\ApiCore\ApiException;
use Google\Cloud\ServiceDirectory\V1\Client\RegistrationServiceClient;
use Google\Cloud\ServiceDirectory\V1\DeleteEndpointRequest;

/**
 * @param string $formattedName The name of the endpoint to delete. Please see
 *                              {@see RegistrationServiceClient::endpointName()} for help formatting this field.
 */
function delete_endpoint_sample(string $formattedName): void
{
    // Create a client.
    $registrationServiceClient = new RegistrationServiceClient();

    // Prepare the request message.
    $request = (new DeleteEndpointRequest())
        ->setName($formattedName);

    // Call the API and handle any network failures.
    try {
        $registrationServiceClient->deleteEndpoint($request);
        printf('Call completed successfully.' . PHP_EOL);
    } catch (ApiException $ex) {
        printf('Call failed with message: %s' . PHP_EOL, $ex->getMessage());
    }
}

/**
 * Helper to execute the sample.
 *
 * This sample has been automatically generated and should be regarded as a code
 * template only. It will require modifications to work:
 *  - It may require correct/in-range values for request initialization.
 *  - It may require specifying regional endpoints when creating the service client,
 *    please see the apiEndpoint client configuration option for more details.
 */
function callSample(): void
{
    $formattedName = RegistrationServiceClient::endpointName(
        '[PROJECT]',
        '[LOCATION]',
        '[NAMESPACE]',
        '[SERVICE]',
        '[ENDPOINT]'
    );

    delete_endpoint_sample($formattedName);
}

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.
Example 
use Google\ApiCore\ApiException;
use Google\Cloud\ServiceDirectory\V1\Client\RegistrationServiceClient;
use Google\Cloud\ServiceDirectory\V1\DeleteNamespaceRequest;

/**
 * @param string $formattedName The name of the namespace to delete. Please see
 *                              {@see RegistrationServiceClient::namespaceName()} for help formatting this field.
 */
function delete_namespace_sample(string $formattedName): void
{
    // Create a client.
    $registrationServiceClient = new RegistrationServiceClient();

    // Prepare the request message.
    $request = (new DeleteNamespaceRequest())
        ->setName($formattedName);

    // Call the API and handle any network failures.
    try {
        $registrationServiceClient->deleteNamespace($request);
        printf('Call completed successfully.' . PHP_EOL);
    } catch (ApiException $ex) {
        printf('Call failed with message: %s' . PHP_EOL, $ex->getMessage());
    }
}

/**
 * Helper to execute the sample.
 *
 * This sample has been automatically generated and should be regarded as a code
 * template only. It will require modifications to work:
 *  - It may require correct/in-range values for request initialization.
 *  - It may require specifying regional endpoints when creating the service client,
 *    please see the apiEndpoint client configuration option for more details.
 */
function callSample(): void
{
    $formattedName = RegistrationServiceClient::namespaceName('[PROJECT]', '[LOCATION]', '[NAMESPACE]');

    delete_namespace_sample($formattedName);
}

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.
Example 
use Google\ApiCore\ApiException;
use Google\Cloud\ServiceDirectory\V1\Client\RegistrationServiceClient;
use Google\Cloud\ServiceDirectory\V1\DeleteServiceRequest;

/**
 * @param string $formattedName The name of the service to delete. Please see
 *                              {@see RegistrationServiceClient::serviceName()} for help formatting this field.
 */
function delete_service_sample(string $formattedName): void
{
    // Create a client.
    $registrationServiceClient = new RegistrationServiceClient();

    // Prepare the request message.
    $request = (new DeleteServiceRequest())
        ->setName($formattedName);

    // Call the API and handle any network failures.
    try {
        $registrationServiceClient->deleteService($request);
        printf('Call completed successfully.' . PHP_EOL);
    } catch (ApiException $ex) {
        printf('Call failed with message: %s' . PHP_EOL, $ex->getMessage());
    }
}

/**
 * Helper to execute the sample.
 *
 * This sample has been automatically generated and should be regarded as a code
 * template only. It will require modifications to work:
 *  - It may require correct/in-range values for request initialization.
 *  - It may require specifying regional endpoints when creating the service client,
 *    please see the apiEndpoint client configuration option for more details.
 */
function callSample(): void
{
    $formattedName = RegistrationServiceClient::serviceName(
        '[PROJECT]',
        '[LOCATION]',
        '[NAMESPACE]',
        '[SERVICE]'
    );

    delete_service_sample($formattedName);
}

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
Example 
use Google\ApiCore\ApiException;
use Google\Cloud\ServiceDirectory\V1\Client\RegistrationServiceClient;
use Google\Cloud\ServiceDirectory\V1\Endpoint;
use Google\Cloud\ServiceDirectory\V1\GetEndpointRequest;

/**
 * @param string $formattedName The name of the endpoint to get. Please see
 *                              {@see RegistrationServiceClient::endpointName()} for help formatting this field.
 */
function get_endpoint_sample(string $formattedName): void
{
    // Create a client.
    $registrationServiceClient = new RegistrationServiceClient();

    // Prepare the request message.
    $request = (new GetEndpointRequest())
        ->setName($formattedName);

    // Call the API and handle any network failures.
    try {
        /** @var Endpoint $response */
        $response = $registrationServiceClient->getEndpoint($request);
        printf('Response data: %s' . PHP_EOL, $response->serializeToJsonString());
    } catch (ApiException $ex) {
        printf('Call failed with message: %s' . PHP_EOL, $ex->getMessage());
    }
}

/**
 * Helper to execute the sample.
 *
 * This sample has been automatically generated and should be regarded as a code
 * template only. It will require modifications to work:
 *  - It may require correct/in-range values for request initialization.
 *  - It may require specifying regional endpoints when creating the service client,
 *    please see the apiEndpoint client configuration option for more details.
 */
function callSample(): void
{
    $formattedName = RegistrationServiceClient::endpointName(
        '[PROJECT]',
        '[LOCATION]',
        '[NAMESPACE]',
        '[SERVICE]',
        '[ENDPOINT]'
    );

    get_endpoint_sample($formattedName);
}

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
Example 
use Google\ApiCore\ApiException;
use Google\Cloud\Iam\V1\GetIamPolicyRequest;
use Google\Cloud\Iam\V1\Policy;
use Google\Cloud\ServiceDirectory\V1\Client\RegistrationServiceClient;

/**
 * @param string $resource REQUIRED: The resource for which the policy is being requested.
 *                         See the operation documentation for the appropriate value for this field.
 */
function get_iam_policy_sample(string $resource): void
{
    // Create a client.
    $registrationServiceClient = new RegistrationServiceClient();

    // Prepare the request message.
    $request = (new GetIamPolicyRequest())
        ->setResource($resource);

    // Call the API and handle any network failures.
    try {
        /** @var Policy $response */
        $response = $registrationServiceClient->getIamPolicy($request);
        printf('Response data: %s' . PHP_EOL, $response->serializeToJsonString());
    } catch (ApiException $ex) {
        printf('Call failed with message: %s' . PHP_EOL, $ex->getMessage());
    }
}

/**
 * Helper to execute the sample.
 *
 * This sample has been automatically generated and should be regarded as a code
 * template only. It will require modifications to work:
 *  - It may require correct/in-range values for request initialization.
 *  - It may require specifying regional endpoints when creating the service client,
 *    please see the apiEndpoint client configuration option for more details.
 */
function callSample(): void
{
    $resource = '[RESOURCE]';

    get_iam_policy_sample($resource);
}

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
Example 
use Google\ApiCore\ApiException;
use Google\Cloud\ServiceDirectory\V1\Client\RegistrationServiceClient;
use Google\Cloud\ServiceDirectory\V1\GetNamespaceRequest;
use Google\Cloud\ServiceDirectory\V1\PBNamespace;

/**
 * @param string $formattedName The name of the namespace to retrieve. Please see
 *                              {@see RegistrationServiceClient::namespaceName()} for help formatting this field.
 */
function get_namespace_sample(string $formattedName): void
{
    // Create a client.
    $registrationServiceClient = new RegistrationServiceClient();

    // Prepare the request message.
    $request = (new GetNamespaceRequest())
        ->setName($formattedName);

    // Call the API and handle any network failures.
    try {
        /** @var PBNamespace $response */
        $response = $registrationServiceClient->getNamespace($request);
        printf('Response data: %s' . PHP_EOL, $response->serializeToJsonString());
    } catch (ApiException $ex) {
        printf('Call failed with message: %s' . PHP_EOL, $ex->getMessage());
    }
}

/**
 * Helper to execute the sample.
 *
 * This sample has been automatically generated and should be regarded as a code
 * template only. It will require modifications to work:
 *  - It may require correct/in-range values for request initialization.
 *  - It may require specifying regional endpoints when creating the service client,
 *    please see the apiEndpoint client configuration option for more details.
 */
function callSample(): void
{
    $formattedName = RegistrationServiceClient::namespaceName('[PROJECT]', '[LOCATION]', '[NAMESPACE]');

    get_namespace_sample($formattedName);
}

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
Example 
use Google\ApiCore\ApiException;
use Google\Cloud\ServiceDirectory\V1\Client\RegistrationServiceClient;
use Google\Cloud\ServiceDirectory\V1\GetServiceRequest;
use Google\Cloud\ServiceDirectory\V1\Service;

/**
 * @param string $formattedName The name of the service to get. Please see
 *                              {@see RegistrationServiceClient::serviceName()} for help formatting this field.
 */
function get_service_sample(string $formattedName): void
{
    // Create a client.
    $registrationServiceClient = new RegistrationServiceClient();

    // Prepare the request message.
    $request = (new GetServiceRequest())
        ->setName($formattedName);

    // Call the API and handle any network failures.
    try {
        /** @var Service $response */
        $response = $registrationServiceClient->getService($request);
        printf('Response data: %s' . PHP_EOL, $response->serializeToJsonString());
    } catch (ApiException $ex) {
        printf('Call failed with message: %s' . PHP_EOL, $ex->getMessage());
    }
}

/**
 * Helper to execute the sample.
 *
 * This sample has been automatically generated and should be regarded as a code
 * template only. It will require modifications to work:
 *  - It may require correct/in-range values for request initialization.
 *  - It may require specifying regional endpoints when creating the service client,
 *    please see the apiEndpoint client configuration option for more details.
 */
function callSample(): void
{
    $formattedName = RegistrationServiceClient::serviceName(
        '[PROJECT]',
        '[LOCATION]',
        '[NAMESPACE]',
        '[SERVICE]'
    );

    get_service_sample($formattedName);
}

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
Example 
use Google\ApiCore\ApiException;
use Google\ApiCore\PagedListResponse;
use Google\Cloud\ServiceDirectory\V1\Client\RegistrationServiceClient;
use Google\Cloud\ServiceDirectory\V1\Endpoint;
use Google\Cloud\ServiceDirectory\V1\ListEndpointsRequest;

/**
 * @param string $formattedParent The resource name of the service whose endpoints you'd like to
 *                                list. Please see
 *                                {@see RegistrationServiceClient::serviceName()} for help formatting this field.
 */
function list_endpoints_sample(string $formattedParent): void
{
    // Create a client.
    $registrationServiceClient = new RegistrationServiceClient();

    // Prepare the request message.
    $request = (new ListEndpointsRequest())
        ->setParent($formattedParent);

    // Call the API and handle any network failures.
    try {
        /** @var PagedListResponse $response */
        $response = $registrationServiceClient->listEndpoints($request);

        /** @var Endpoint $element */
        foreach ($response as $element) {
            printf('Element data: %s' . PHP_EOL, $element->serializeToJsonString());
        }
    } catch (ApiException $ex) {
        printf('Call failed with message: %s' . PHP_EOL, $ex->getMessage());
    }
}

/**
 * Helper to execute the sample.
 *
 * This sample has been automatically generated and should be regarded as a code
 * template only. It will require modifications to work:
 *  - It may require correct/in-range values for request initialization.
 *  - It may require specifying regional endpoints when creating the service client,
 *    please see the apiEndpoint client configuration option for more details.
 */
function callSample(): void
{
    $formattedParent = RegistrationServiceClient::serviceName(
        '[PROJECT]',
        '[LOCATION]',
        '[NAMESPACE]',
        '[SERVICE]'
    );

    list_endpoints_sample($formattedParent);
}

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
Example 
use Google\ApiCore\ApiException;
use Google\ApiCore\PagedListResponse;
use Google\Cloud\ServiceDirectory\V1\Client\RegistrationServiceClient;
use Google\Cloud\ServiceDirectory\V1\ListNamespacesRequest;
use Google\Cloud\ServiceDirectory\V1\PBNamespace;

/**
 * @param string $formattedParent The resource name of the project and location whose namespaces
 *                                you'd like to list. Please see
 *                                {@see RegistrationServiceClient::locationName()} for help formatting this field.
 */
function list_namespaces_sample(string $formattedParent): void
{
    // Create a client.
    $registrationServiceClient = new RegistrationServiceClient();

    // Prepare the request message.
    $request = (new ListNamespacesRequest())
        ->setParent($formattedParent);

    // Call the API and handle any network failures.
    try {
        /** @var PagedListResponse $response */
        $response = $registrationServiceClient->listNamespaces($request);

        /** @var PBNamespace $element */
        foreach ($response as $element) {
            printf('Element data: %s' . PHP_EOL, $element->serializeToJsonString());
        }
    } catch (ApiException $ex) {
        printf('Call failed with message: %s' . PHP_EOL, $ex->getMessage());
    }
}

/**
 * Helper to execute the sample.
 *
 * This sample has been automatically generated and should be regarded as a code
 * template only. It will require modifications to work:
 *  - It may require correct/in-range values for request initialization.
 *  - It may require specifying regional endpoints when creating the service client,
 *    please see the apiEndpoint client configuration option for more details.
 */
function callSample(): void
{
    $formattedParent = RegistrationServiceClient::locationName('[PROJECT]', '[LOCATION]');

    list_namespaces_sample($formattedParent);
}

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
Example 
use Google\ApiCore\ApiException;
use Google\ApiCore\PagedListResponse;
use Google\Cloud\ServiceDirectory\V1\Client\RegistrationServiceClient;
use Google\Cloud\ServiceDirectory\V1\ListServicesRequest;
use Google\Cloud\ServiceDirectory\V1\Service;

/**
 * @param string $formattedParent The resource name of the namespace whose services you'd
 *                                like to list. Please see
 *                                {@see RegistrationServiceClient::namespaceName()} for help formatting this field.
 */
function list_services_sample(string $formattedParent): void
{
    // Create a client.
    $registrationServiceClient = new RegistrationServiceClient();

    // Prepare the request message.
    $request = (new ListServicesRequest())
        ->setParent($formattedParent);

    // Call the API and handle any network failures.
    try {
        /** @var PagedListResponse $response */
        $response = $registrationServiceClient->listServices($request);

        /** @var Service $element */
        foreach ($response as $element) {
            printf('Element data: %s' . PHP_EOL, $element->serializeToJsonString());
        }
    } catch (ApiException $ex) {
        printf('Call failed with message: %s' . PHP_EOL, $ex->getMessage());
    }
}

/**
 * Helper to execute the sample.
 *
 * This sample has been automatically generated and should be regarded as a code
 * template only. It will require modifications to work:
 *  - It may require correct/in-range values for request initialization.
 *  - It may require specifying regional endpoints when creating the service client,
 *    please see the apiEndpoint client configuration option for more details.
 */
function callSample(): void
{
    $formattedParent = RegistrationServiceClient::namespaceName(
        '[PROJECT]',
        '[LOCATION]',
        '[NAMESPACE]'
    );

    list_services_sample($formattedParent);
}

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
Example 
use Google\ApiCore\ApiException;
use Google\Cloud\Iam\V1\Policy;
use Google\Cloud\Iam\V1\SetIamPolicyRequest;
use Google\Cloud\ServiceDirectory\V1\Client\RegistrationServiceClient;

/**
 * @param string $resource REQUIRED: The resource for which the policy is being specified.
 *                         See the operation documentation for the appropriate value for this field.
 */
function set_iam_policy_sample(string $resource): void
{
    // Create a client.
    $registrationServiceClient = new RegistrationServiceClient();

    // Prepare the request message.
    $policy = new Policy();
    $request = (new SetIamPolicyRequest())
        ->setResource($resource)
        ->setPolicy($policy);

    // Call the API and handle any network failures.
    try {
        /** @var Policy $response */
        $response = $registrationServiceClient->setIamPolicy($request);
        printf('Response data: %s' . PHP_EOL, $response->serializeToJsonString());
    } catch (ApiException $ex) {
        printf('Call failed with message: %s' . PHP_EOL, $ex->getMessage());
    }
}

/**
 * Helper to execute the sample.
 *
 * This sample has been automatically generated and should be regarded as a code
 * template only. It will require modifications to work:
 *  - It may require correct/in-range values for request initialization.
 *  - It may require specifying regional endpoints when creating the service client,
 *    please see the apiEndpoint client configuration option for more details.
 */
function callSample(): void
{
    $resource = '[RESOURCE]';

    set_iam_policy_sample($resource);
}

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
Example 
use Google\ApiCore\ApiException;
use Google\Cloud\Iam\V1\TestIamPermissionsRequest;
use Google\Cloud\Iam\V1\TestIamPermissionsResponse;
use Google\Cloud\ServiceDirectory\V1\Client\RegistrationServiceClient;

/**
 * @param string $resource           REQUIRED: The resource for which the policy detail is being requested.
 *                                   See the operation documentation for the appropriate value for this field.
 * @param string $permissionsElement 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](https://cloud.google.com/iam/docs/overview#permissions).
 */
function test_iam_permissions_sample(string $resource, string $permissionsElement): void
{
    // Create a client.
    $registrationServiceClient = new RegistrationServiceClient();

    // Prepare the request message.
    $permissions = [$permissionsElement,];
    $request = (new TestIamPermissionsRequest())
        ->setResource($resource)
        ->setPermissions($permissions);

    // Call the API and handle any network failures.
    try {
        /** @var TestIamPermissionsResponse $response */
        $response = $registrationServiceClient->testIamPermissions($request);
        printf('Response data: %s' . PHP_EOL, $response->serializeToJsonString());
    } catch (ApiException $ex) {
        printf('Call failed with message: %s' . PHP_EOL, $ex->getMessage());
    }
}

/**
 * Helper to execute the sample.
 *
 * This sample has been automatically generated and should be regarded as a code
 * template only. It will require modifications to work:
 *  - It may require correct/in-range values for request initialization.
 *  - It may require specifying regional endpoints when creating the service client,
 *    please see the apiEndpoint client configuration option for more details.
 */
function callSample(): void
{
    $resource = '[RESOURCE]';
    $permissionsElement = '[PERMISSIONS]';

    test_iam_permissions_sample($resource, $permissionsElement);
}

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
Example 
use Google\ApiCore\ApiException;
use Google\Cloud\ServiceDirectory\V1\Client\RegistrationServiceClient;
use Google\Cloud\ServiceDirectory\V1\Endpoint;
use Google\Cloud\ServiceDirectory\V1\UpdateEndpointRequest;
use Google\Protobuf\FieldMask;

/**
 * This sample has been automatically generated and should be regarded as a code
 * template only. It will require modifications to work:
 *  - It may require correct/in-range values for request initialization.
 *  - It may require specifying regional endpoints when creating the service client,
 *    please see the apiEndpoint client configuration option for more details.
 */
function update_endpoint_sample(): void
{
    // Create a client.
    $registrationServiceClient = new RegistrationServiceClient();

    // Prepare the request message.
    $endpoint = new Endpoint();
    $updateMask = new FieldMask();
    $request = (new UpdateEndpointRequest())
        ->setEndpoint($endpoint)
        ->setUpdateMask($updateMask);

    // Call the API and handle any network failures.
    try {
        /** @var Endpoint $response */
        $response = $registrationServiceClient->updateEndpoint($request);
        printf('Response data: %s' . PHP_EOL, $response->serializeToJsonString());
    } catch (ApiException $ex) {
        printf('Call failed with message: %s' . PHP_EOL, $ex->getMessage());
    }
}

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
Example 
use Google\ApiCore\ApiException;
use Google\Cloud\ServiceDirectory\V1\Client\RegistrationServiceClient;
use Google\Cloud\ServiceDirectory\V1\PBNamespace;
use Google\Cloud\ServiceDirectory\V1\UpdateNamespaceRequest;
use Google\Protobuf\FieldMask;

/**
 * This sample has been automatically generated and should be regarded as a code
 * template only. It will require modifications to work:
 *  - It may require correct/in-range values for request initialization.
 *  - It may require specifying regional endpoints when creating the service client,
 *    please see the apiEndpoint client configuration option for more details.
 */
function update_namespace_sample(): void
{
    // Create a client.
    $registrationServiceClient = new RegistrationServiceClient();

    // Prepare the request message.
    $namespace = new PBNamespace();
    $updateMask = new FieldMask();
    $request = (new UpdateNamespaceRequest())
        ->setNamespace($namespace)
        ->setUpdateMask($updateMask);

    // Call the API and handle any network failures.
    try {
        /** @var PBNamespace $response */
        $response = $registrationServiceClient->updateNamespace($request);
        printf('Response data: %s' . PHP_EOL, $response->serializeToJsonString());
    } catch (ApiException $ex) {
        printf('Call failed with message: %s' . PHP_EOL, $ex->getMessage());
    }
}

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
Example 
use Google\ApiCore\ApiException;
use Google\Cloud\ServiceDirectory\V1\Client\RegistrationServiceClient;
use Google\Cloud\ServiceDirectory\V1\Service;
use Google\Cloud\ServiceDirectory\V1\UpdateServiceRequest;
use Google\Protobuf\FieldMask;

/**
 * This sample has been automatically generated and should be regarded as a code
 * template only. It will require modifications to work:
 *  - It may require correct/in-range values for request initialization.
 *  - It may require specifying regional endpoints when creating the service client,
 *    please see the apiEndpoint client configuration option for more details.
 */
function update_service_sample(): void
{
    // Create a client.
    $registrationServiceClient = new RegistrationServiceClient();

    // Prepare the request message.
    $service = new Service();
    $updateMask = new FieldMask();
    $request = (new UpdateServiceRequest())
        ->setService($service)
        ->setUpdateMask($updateMask);

    // Call the API and handle any network failures.
    try {
        /** @var Service $response */
        $response = $registrationServiceClient->updateService($request);
        printf('Response data: %s' . PHP_EOL, $response->serializeToJsonString());
    } catch (ApiException $ex) {
        printf('Call failed with message: %s' . PHP_EOL, $ex->getMessage());
    }
}

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
Example 
use Google\ApiCore\ApiException;
use Google\Cloud\Location\GetLocationRequest;
use Google\Cloud\Location\Location;
use Google\Cloud\ServiceDirectory\V1\Client\RegistrationServiceClient;

/**
 * This sample has been automatically generated and should be regarded as a code
 * template only. It will require modifications to work:
 *  - It may require correct/in-range values for request initialization.
 *  - It may require specifying regional endpoints when creating the service client,
 *    please see the apiEndpoint client configuration option for more details.
 */
function get_location_sample(): void
{
    // Create a client.
    $registrationServiceClient = new RegistrationServiceClient();

    // Prepare the request message.
    $request = new GetLocationRequest();

    // Call the API and handle any network failures.
    try {
        /** @var Location $response */
        $response = $registrationServiceClient->getLocation($request);
        printf('Response data: %s' . PHP_EOL, $response->serializeToJsonString());
    } catch (ApiException $ex) {
        printf('Call failed with message: %s' . PHP_EOL, $ex->getMessage());
    }
}

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
Example 
use Google\ApiCore\ApiException;
use Google\ApiCore\PagedListResponse;
use Google\Cloud\Location\ListLocationsRequest;
use Google\Cloud\Location\Location;
use Google\Cloud\ServiceDirectory\V1\Client\RegistrationServiceClient;

/**
 * This sample has been automatically generated and should be regarded as a code
 * template only. It will require modifications to work:
 *  - It may require correct/in-range values for request initialization.
 *  - It may require specifying regional endpoints when creating the service client,
 *    please see the apiEndpoint client configuration option for more details.
 */
function list_locations_sample(): void
{
    // Create a client.
    $registrationServiceClient = new RegistrationServiceClient();

    // Prepare the request message.
    $request = new ListLocationsRequest();

    // Call the API and handle any network failures.
    try {
        /** @var PagedListResponse $response */
        $response = $registrationServiceClient->listLocations($request);

        /** @var Location $element */
        foreach ($response as $element) {
            printf('Element data: %s' . PHP_EOL, $element->serializeToJsonString());
        }
    } catch (ApiException $ex) {
        printf('Call failed with message: %s' . PHP_EOL, $ex->getMessage());
    }
}

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.