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. Sample code to get started:
$registrationServiceClient = new RegistrationServiceClient();
try {
$formattedParent = $registrationServiceClient->serviceName('[PROJECT]', '[LOCATION]', '[NAMESPACE]', '[SERVICE]');
$endpointId = 'endpoint_id';
$endpoint = new Endpoint();
$response = $registrationServiceClient->createEndpoint($formattedParent, $endpointId, $endpoint);
} finally {
$registrationServiceClient->close();
}
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 service has a new (beta) implementation. See Google\Cloud\ServiceDirectory\V1\Client\RegistrationServiceClient to use the new surface.
Namespace
Google \ Cloud \ ServiceDirectory \ V1Methods
__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 |
↳ 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 |
↳ 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 a endpoint, and returns the new Endpoint.
Parameters | |
---|---|
Name | 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 |
endpoint |
Google\Cloud\ServiceDirectory\V1\Endpoint
Required. A endpoint with initial fields set. |
optionalArgs |
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 |
use Google\ApiCore\ApiException;
use Google\Cloud\ServiceDirectory\V1\Endpoint;
use Google\Cloud\ServiceDirectory\V1\RegistrationServiceClient;
/**
* @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 any non-scalar elements to be passed along with the request.
$endpoint = new Endpoint();
// Call the API and handle any network failures.
try {
/** @var Endpoint $response */
$response = $registrationServiceClient->createEndpoint($formattedParent, $endpointId, $endpoint);
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.
Parameters | |
---|---|
Name | 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 |
namespace |
Google\Cloud\ServiceDirectory\V1\PBNamespace
Required. A namespace with initial fields set. |
optionalArgs |
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 |
use Google\ApiCore\ApiException;
use Google\Cloud\ServiceDirectory\V1\PBNamespace;
use Google\Cloud\ServiceDirectory\V1\RegistrationServiceClient;
/**
* @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 any non-scalar elements to be passed along with the request.
$namespace = new PBNamespace();
// Call the API and handle any network failures.
try {
/** @var PBNamespace $response */
$response = $registrationServiceClient->createNamespace($formattedParent, $namespaceId, $namespace);
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.
Parameters | |
---|---|
Name | 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 |
service |
Google\Cloud\ServiceDirectory\V1\Service
Required. A service with initial fields set. |
optionalArgs |
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 |
use Google\ApiCore\ApiException;
use Google\Cloud\ServiceDirectory\V1\RegistrationServiceClient;
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 any non-scalar elements to be passed along with the request.
$service = new Service();
// Call the API and handle any network failures.
try {
/** @var Service $response */
$response = $registrationServiceClient->createService($formattedParent, $serviceId, $service);
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 a endpoint.
Parameters | |
---|---|
Name | Description |
name |
string
Required. The name of the endpoint to delete. |
optionalArgs |
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. |
use Google\ApiCore\ApiException;
use Google\Cloud\ServiceDirectory\V1\RegistrationServiceClient;
/**
* @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();
// Call the API and handle any network failures.
try {
$registrationServiceClient->deleteEndpoint($formattedName);
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.
Parameters | |
---|---|
Name | Description |
name |
string
Required. The name of the namespace to delete. |
optionalArgs |
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. |
use Google\ApiCore\ApiException;
use Google\Cloud\ServiceDirectory\V1\RegistrationServiceClient;
/**
* @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();
// Call the API and handle any network failures.
try {
$registrationServiceClient->deleteNamespace($formattedName);
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.
Parameters | |
---|---|
Name | Description |
name |
string
Required. The name of the service to delete. |
optionalArgs |
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. |
use Google\ApiCore\ApiException;
use Google\Cloud\ServiceDirectory\V1\RegistrationServiceClient;
/**
* @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();
// Call the API and handle any network failures.
try {
$registrationServiceClient->deleteService($formattedName);
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 a endpoint.
Parameters | |
---|---|
Name | Description |
name |
string
Required. The name of the endpoint to get. |
optionalArgs |
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 |
use Google\ApiCore\ApiException;
use Google\Cloud\ServiceDirectory\V1\Endpoint;
use Google\Cloud\ServiceDirectory\V1\RegistrationServiceClient;
/**
* @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();
// Call the API and handle any network failures.
try {
/** @var Endpoint $response */
$response = $registrationServiceClient->getEndpoint($formattedName);
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).
Parameters | |
---|---|
Name | Description |
resource |
string
REQUIRED: The resource for which the policy is being requested. See the operation documentation for the appropriate value for this field. |
optionalArgs |
array
Optional. |
↳ options |
GetPolicyOptions
OPTIONAL: A |
↳ 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 |
use Google\ApiCore\ApiException;
use Google\Cloud\Iam\V1\Policy;
use Google\Cloud\ServiceDirectory\V1\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();
// Call the API and handle any network failures.
try {
/** @var Policy $response */
$response = $registrationServiceClient->getIamPolicy($resource);
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.
Parameters | |
---|---|
Name | Description |
name |
string
Required. The name of the namespace to retrieve. |
optionalArgs |
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 |
use Google\ApiCore\ApiException;
use Google\Cloud\ServiceDirectory\V1\PBNamespace;
use Google\Cloud\ServiceDirectory\V1\RegistrationServiceClient;
/**
* @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();
// Call the API and handle any network failures.
try {
/** @var PBNamespace $response */
$response = $registrationServiceClient->getNamespace($formattedName);
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.
Parameters | |
---|---|
Name | Description |
name |
string
Required. The name of the service to get. |
optionalArgs |
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 |
use Google\ApiCore\ApiException;
use Google\Cloud\ServiceDirectory\V1\RegistrationServiceClient;
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();
// Call the API and handle any network failures.
try {
/** @var Service $response */
$response = $registrationServiceClient->getService($formattedName);
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.
Parameters | |
---|---|
Name | Description |
parent |
string
Required. The resource name of the service whose endpoints we'd like to list. |
optionalArgs |
array
Optional. |
↳ pageSize |
int
The maximum number of resources contained in the underlying API response. The API may return fewer values in a page, even if there are additional values to be retrieved. |
↳ pageToken |
string
A page token is used to specify a page of values to be returned. If no page token is specified (the default), the first page of values will be returned. Any page token used here must have been generated by a previous call to the API. |
↳ filter |
string
Optional. The filter to list result by. General filter string syntax:
|
↳ orderBy |
string
Optional. The order to list result by. |
↳ 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 |
use Google\ApiCore\ApiException;
use Google\ApiCore\PagedListResponse;
use Google\Cloud\ServiceDirectory\V1\Endpoint;
use Google\Cloud\ServiceDirectory\V1\RegistrationServiceClient;
/**
* @param string $formattedParent The resource name of the service whose endpoints we'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();
// Call the API and handle any network failures.
try {
/** @var PagedListResponse $response */
$response = $registrationServiceClient->listEndpoints($formattedParent);
/** @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.
Parameters | |
---|---|
Name | Description |
parent |
string
Required. The resource name of the project and location whose namespaces we'd like to list. |
optionalArgs |
array
Optional. |
↳ pageSize |
int
The maximum number of resources contained in the underlying API response. The API may return fewer values in a page, even if there are additional values to be retrieved. |
↳ pageToken |
string
A page token is used to specify a page of values to be returned. If no page token is specified (the default), the first page of values will be returned. Any page token used here must have been generated by a previous call to the API. |
↳ filter |
string
Optional. The filter to list result by. General filter string syntax:
|
↳ orderBy |
string
Optional. The order to list result by. General order by string syntax:
|
↳ 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 |
use Google\ApiCore\ApiException;
use Google\ApiCore\PagedListResponse;
use Google\Cloud\ServiceDirectory\V1\PBNamespace;
use Google\Cloud\ServiceDirectory\V1\RegistrationServiceClient;
/**
* @param string $formattedParent The resource name of the project and location whose namespaces
* we'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();
// Call the API and handle any network failures.
try {
/** @var PagedListResponse $response */
$response = $registrationServiceClient->listNamespaces($formattedParent);
/** @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.
Parameters | |
---|---|
Name | Description |
parent |
string
Required. The resource name of the namespace whose services we'd like to list. |
optionalArgs |
array
Optional. |
↳ pageSize |
int
The maximum number of resources contained in the underlying API response. The API may return fewer values in a page, even if there are additional values to be retrieved. |
↳ pageToken |
string
A page token is used to specify a page of values to be returned. If no page token is specified (the default), the first page of values will be returned. Any page token used here must have been generated by a previous call to the API. |
↳ filter |
string
Optional. The filter to list result by. General filter string syntax:
|
↳ orderBy |
string
Optional. The order to list result by. |
↳ 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 |
use Google\ApiCore\ApiException;
use Google\ApiCore\PagedListResponse;
use Google\Cloud\ServiceDirectory\V1\RegistrationServiceClient;
use Google\Cloud\ServiceDirectory\V1\Service;
/**
* @param string $formattedParent The resource name of the namespace whose services we'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();
// Call the API and handle any network failures.
try {
/** @var PagedListResponse $response */
$response = $registrationServiceClient->listServices($formattedParent);
/** @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).
Parameters | |
---|---|
Name | 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\Cloud\Iam\V1\Policy
REQUIRED: The complete policy to be applied to the |
optionalArgs |
array
Optional. |
↳ updateMask |
FieldMask
OPTIONAL: A FieldMask specifying which fields of the policy to modify. Only the fields in the mask will be modified. If no mask is provided, the following default mask is used: |
↳ 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 |
use Google\ApiCore\ApiException;
use Google\Cloud\Iam\V1\Policy;
use Google\Cloud\ServiceDirectory\V1\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 any non-scalar elements to be passed along with the request.
$policy = new Policy();
// Call the API and handle any network failures.
try {
/** @var Policy $response */
$response = $registrationServiceClient->setIamPolicy($resource, $policy);
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).
Parameters | |
---|---|
Name | 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 |
string[]
The set of permissions to check for the |
optionalArgs |
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 |
use Google\ApiCore\ApiException;
use Google\Cloud\Iam\V1\TestIamPermissionsResponse;
use Google\Cloud\ServiceDirectory\V1\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 any non-scalar elements to be passed along with the request.
$permissions = [$permissionsElement,];
// Call the API and handle any network failures.
try {
/** @var TestIamPermissionsResponse $response */
$response = $registrationServiceClient->testIamPermissions($resource, $permissions);
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 a endpoint.
Parameters | |
---|---|
Name | Description |
endpoint |
Google\Cloud\ServiceDirectory\V1\Endpoint
Required. The updated endpoint. |
updateMask |
Google\Protobuf\FieldMask
Required. List of fields to be updated in this request. |
optionalArgs |
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 |
use Google\ApiCore\ApiException;
use Google\Cloud\ServiceDirectory\V1\Endpoint;
use Google\Cloud\ServiceDirectory\V1\RegistrationServiceClient;
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 any non-scalar elements to be passed along with the request.
$endpoint = new Endpoint();
$updateMask = new FieldMask();
// Call the API and handle any network failures.
try {
/** @var Endpoint $response */
$response = $registrationServiceClient->updateEndpoint($endpoint, $updateMask);
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.
Parameters | |
---|---|
Name | Description |
namespace |
Google\Cloud\ServiceDirectory\V1\PBNamespace
Required. The updated namespace. |
updateMask |
Google\Protobuf\FieldMask
Required. List of fields to be updated in this request. |
optionalArgs |
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 |
use Google\ApiCore\ApiException;
use Google\Cloud\ServiceDirectory\V1\PBNamespace;
use Google\Cloud\ServiceDirectory\V1\RegistrationServiceClient;
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 any non-scalar elements to be passed along with the request.
$namespace = new PBNamespace();
$updateMask = new FieldMask();
// Call the API and handle any network failures.
try {
/** @var PBNamespace $response */
$response = $registrationServiceClient->updateNamespace($namespace, $updateMask);
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.
Parameters | |
---|---|
Name | Description |
service |
Google\Cloud\ServiceDirectory\V1\Service
Required. The updated service. |
updateMask |
Google\Protobuf\FieldMask
Required. List of fields to be updated in this request. |
optionalArgs |
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 |
use Google\ApiCore\ApiException;
use Google\Cloud\ServiceDirectory\V1\RegistrationServiceClient;
use Google\Cloud\ServiceDirectory\V1\Service;
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 any non-scalar elements to be passed along with the request.
$service = new Service();
$updateMask = new FieldMask();
// Call the API and handle any network failures.
try {
/** @var Service $response */
$response = $registrationServiceClient->updateService($service, $updateMask);
printf('Response data: %s' . PHP_EOL, $response->serializeToJsonString());
} catch (ApiException $ex) {
printf('Call failed with message: %s' . PHP_EOL, $ex->getMessage());
}
}
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::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}
- 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. |
Constants
SERVICE_NAME
Value: 'google.cloud.servicedirectory.v1.RegistrationService'
The name of the service.
SERVICE_ADDRESS
Value: 'servicedirectory.googleapis.com'
The default address of the service.
DEFAULT_SERVICE_PORT
Value: 443
The default port of the service.
CODEGEN_NAME
Value: 'gapic'
The name of the code generator, to be included in the agent header.