Reference documentation and code samples for the Google Cloud Run V2 Client class ServicesClient.
Service Description: Cloud Run Service Control Plane API
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 \ Run \ V2 \ ClientMethods
__construct
Constructor.
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. Important : If you accept a credential configuration (credential JSON/File/Stream) from an external source for authentication to Google Cloud Platform, you must validate it before providing it to any Google API or library. Providing an unvalidated credential configuration to Google APIs can compromise the security of your systems and data. For more information https://cloud.google.com/docs/authentication/external/externally-sourced-credentials
↳ 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.
↳ logger
false|LoggerInterface
A PSR-3 compliant logger. If set to false, logging is disabled, ignoring the 'GOOGLE_SDK_PHP_LOGGING' environment flag
createService
Creates a new Service in a given project and location.
The async variant is ServicesClient::createServiceAsync() .
request
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.
use Google\ApiCore\ApiException;
use Google\ApiCore\OperationResponse;
use Google\Cloud\Run\V2\Client\ServicesClient;
use Google\Cloud\Run\V2\CreateServiceRequest;
use Google\Cloud\Run\V2\RevisionTemplate;
use Google\Cloud\Run\V2\Service;
use Google\Rpc\Status;
/**
* @param string $formattedParent The location and project in which this service should be created.
* Format: projects/{project}/locations/{location}, where {project} can be
* project id or number. Only lowercase characters, digits, and hyphens. Please see
* {@see ServicesClient::locationName()} for help formatting this field.
* @param string $serviceId The unique identifier for the Service. It must begin with letter,
* and cannot end with hyphen; must contain fewer than 50 characters.
* The name of the service becomes {parent}/services/{service_id}.
*/
function create_service_sample(string $formattedParent, string $serviceId): void
{
// Create a client.
$servicesClient = new ServicesClient();
// Prepare the request message.
$serviceTemplate = new RevisionTemplate();
$service = (new Service())
->setTemplate($serviceTemplate);
$request = (new CreateServiceRequest())
->setParent($formattedParent)
->setService($service)
->setServiceId($serviceId);
// Call the API and handle any network failures.
try {
/** @var OperationResponse $response */
$response = $servicesClient->createService($request);
$response->pollUntilComplete();
if ($response->operationSucceeded()) {
/** @var Service $result */
$result = $response->getResult();
printf('Operation successful with response data: %s' . PHP_EOL, $result->serializeToJsonString());
} else {
/** @var Status $error */
$error = $response->getError();
printf('Operation failed with error data: %s' . PHP_EOL, $error->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 = ServicesClient::locationName('[PROJECT]', '[LOCATION]');
$serviceId = '[SERVICE_ID]';
create_service_sample($formattedParent, $serviceId);
}
deleteService
Deletes a Service.
This will cause the Service to stop serving traffic and will delete all revisions.
The async variant is ServicesClient::deleteServiceAsync() .
request
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.
use Google\ApiCore\ApiException;
use Google\ApiCore\OperationResponse;
use Google\Cloud\Run\V2\Client\ServicesClient;
use Google\Cloud\Run\V2\DeleteServiceRequest;
use Google\Cloud\Run\V2\Service;
use Google\Rpc\Status;
/**
* @param string $formattedName The full name of the Service.
* Format: projects/{project}/locations/{location}/services/{service}, where
* {project} can be project id or number. Please see
* {@see ServicesClient::serviceName()} for help formatting this field.
*/
function delete_service_sample(string $formattedName): void
{
// Create a client.
$servicesClient = new ServicesClient();
// Prepare the request message.
$request = (new DeleteServiceRequest())
->setName($formattedName);
// Call the API and handle any network failures.
try {
/** @var OperationResponse $response */
$response = $servicesClient->deleteService($request);
$response->pollUntilComplete();
if ($response->operationSucceeded()) {
/** @var Service $result */
$result = $response->getResult();
printf('Operation successful with response data: %s' . PHP_EOL, $result->serializeToJsonString());
} else {
/** @var Status $error */
$error = $response->getError();
printf('Operation failed with error data: %s' . PHP_EOL, $error->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 = ServicesClient::serviceName('[PROJECT]', '[LOCATION]', '[SERVICE]');
delete_service_sample($formattedName);
}
getIamPolicy
Gets the IAM Access Control policy currently in effect for the given Cloud Run Service. This result does not include any inherited policies.
The async variant is ServicesClient::getIamPolicyAsync() .
request
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.
use Google\ApiCore\ApiException;
use Google\Cloud\Iam\V1\GetIamPolicyRequest;
use Google\Cloud\Iam\V1\Policy;
use Google\Cloud\Run\V2\Client\ServicesClient;
/**
* @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.
$servicesClient = new ServicesClient();
// Prepare the request message.
$request = (new GetIamPolicyRequest())
->setResource($resource);
// Call the API and handle any network failures.
try {
/** @var Policy $response */
$response = $servicesClient->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);
}
getService
Gets information about a Service.
The async variant is ServicesClient::getServiceAsync() .
request
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.
use Google\ApiCore\ApiException;
use Google\Cloud\Run\V2\Client\ServicesClient;
use Google\Cloud\Run\V2\GetServiceRequest;
use Google\Cloud\Run\V2\Service;
/**
* @param string $formattedName The full name of the Service.
* Format: projects/{project}/locations/{location}/services/{service}, where
* {project} can be project id or number. Please see
* {@see ServicesClient::serviceName()} for help formatting this field.
*/
function get_service_sample(string $formattedName): void
{
// Create a client.
$servicesClient = new ServicesClient();
// Prepare the request message.
$request = (new GetServiceRequest())
->setName($formattedName);
// Call the API and handle any network failures.
try {
/** @var Service $response */
$response = $servicesClient->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 = ServicesClient::serviceName('[PROJECT]', '[LOCATION]', '[SERVICE]');
get_service_sample($formattedName);
}
listServices
Lists Services. Results are sorted by creation time, descending.
The async variant is ServicesClient::listServicesAsync() .
request
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.
use Google\ApiCore\ApiException;
use Google\ApiCore\PagedListResponse;
use Google\Cloud\Run\V2\Client\ServicesClient;
use Google\Cloud\Run\V2\ListServicesRequest;
use Google\Cloud\Run\V2\Service;
/**
* @param string $formattedParent The location and project to list resources on.
* Location must be a valid Google Cloud region, and cannot be the "-"
* wildcard. Format: projects/{project}/locations/{location}, where {project}
* can be project id or number. Please see
* {@see ServicesClient::locationName()} for help formatting this field.
*/
function list_services_sample(string $formattedParent): void
{
// Create a client.
$servicesClient = new ServicesClient();
// Prepare the request message.
$request = (new ListServicesRequest())
->setParent($formattedParent);
// Call the API and handle any network failures.
try {
/** @var PagedListResponse $response */
$response = $servicesClient->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 = ServicesClient::locationName('[PROJECT]', '[LOCATION]');
list_services_sample($formattedParent);
}
setIamPolicy
Sets the IAM Access control policy for the specified Service. Overwrites any existing policy.
The async variant is ServicesClient::setIamPolicyAsync() .
request
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.
use Google\ApiCore\ApiException;
use Google\Cloud\Iam\V1\Policy;
use Google\Cloud\Iam\V1\SetIamPolicyRequest;
use Google\Cloud\Run\V2\Client\ServicesClient;
/**
* @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.
$servicesClient = new ServicesClient();
// 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 = $servicesClient->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
Returns permissions that a caller has on the specified Project.
There are no permissions required for making this API call.
The async variant is ServicesClient::testIamPermissionsAsync() .
request
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.
use Google\ApiCore\ApiException;
use Google\Cloud\Iam\V1\TestIamPermissionsRequest;
use Google\Cloud\Iam\V1\TestIamPermissionsResponse;
use Google\Cloud\Run\V2\Client\ServicesClient;
/**
* @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.
$servicesClient = new ServicesClient();
// 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 = $servicesClient->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);
}
updateService
Updates a Service.
The async variant is ServicesClient::updateServiceAsync() .
request
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.
use Google\ApiCore\ApiException;
use Google\ApiCore\OperationResponse;
use Google\Cloud\Run\V2\Client\ServicesClient;
use Google\Cloud\Run\V2\RevisionTemplate;
use Google\Cloud\Run\V2\Service;
use Google\Cloud\Run\V2\UpdateServiceRequest;
use Google\Rpc\Status;
/**
* 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.
$servicesClient = new ServicesClient();
// Prepare the request message.
$serviceTemplate = new RevisionTemplate();
$service = (new Service())
->setTemplate($serviceTemplate);
$request = (new UpdateServiceRequest())
->setService($service);
// Call the API and handle any network failures.
try {
/** @var OperationResponse $response */
$response = $servicesClient->updateService($request);
$response->pollUntilComplete();
if ($response->operationSucceeded()) {
/** @var Service $result */
$result = $response->getResult();
printf('Operation successful with response data: %s' . PHP_EOL, $result->serializeToJsonString());
} else {
/** @var Status $error */
$error = $response->getError();
printf('Operation failed with error data: %s' . PHP_EOL, $error->serializeToJsonString());
}
} catch (ApiException $ex) {
printf('Call failed with message: %s' . PHP_EOL, $ex->getMessage());
}
}
createServiceAsync
deleteServiceAsync
getIamPolicyAsync
getServiceAsync
listServicesAsync
setIamPolicyAsync
testIamPermissionsAsync
optionalArgs
array
updateServiceAsync
getOperationsClient
Return an OperationsClient object with the same endpoint as $this.
Google\LongRunning\Client\OperationsClient
resumeOperation
Resume an existing long running operation that was previously started by a long running API method. If $methodName is not provided, or does not match a long running API method, then the operation can still be resumed, but the OperationResponse object will not deserialize the final response.
operationName
string
The name of the long running operation
methodName
string
The name of the method used to start the operation
static::buildName
Formats a string containing the fully-qualified path to represent a build resource.
project
string
location
string
build
string
string
static::connectorName
Formats a string containing the fully-qualified path to represent a connector resource.
project
string
location
string
connector
string
string
static::cryptoKeyName
Formats a string containing the fully-qualified path to represent a crypto_key resource.
project
string
location
string
keyRing
string
cryptoKey
string
string
static::locationName
Formats a string containing the fully-qualified path to represent a location resource.
project
string
location
string
string
static::locationPolicyName
Formats a string containing the fully-qualified path to represent a location_policy resource.
location
string
string
static::meshName
Formats a string containing the fully-qualified path to represent a mesh resource.
project
string
location
string
mesh
string
string
static::policyName
Formats a string containing the fully-qualified path to represent a policy resource.
project
string
string
static::projectPolicyName
Formats a string containing the fully-qualified path to represent a project_policy resource.
project
string
string
static::revisionName
Formats a string containing the fully-qualified path to represent a revision resource.
project
string
location
string
service
string
revision
string
string
static::secretName
Formats a string containing the fully-qualified path to represent a secret resource.
project
string
secret
string
string
static::secretVersionName
Formats a string containing the fully-qualified path to represent a secret_version resource.
project
string
secret
string
version
string
string
static::serviceName
Formats a string containing the fully-qualified path to represent a service resource.
project
string
location
string
service
string
string
static::workerPoolName
Formats a string containing the fully-qualified path to represent a worker_pool resource.
project
string
location
string
workerPool
string
string
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
- build: projects/{project}/locations/{location}/builds/{build}
- connector: projects/{project}/locations/{location}/connectors/{connector}
- cryptoKey: projects/{project}/locations/{location}/keyRings/{key_ring}/cryptoKeys/{crypto_key}
- location: projects/{project}/locations/{location}
- locationPolicy: locations/{location}/policy
- mesh: projects/{project}/locations/{location}/meshes/{mesh}
- policy: projects/{project}/policy
- projectPolicy: projects/{project}/policy
- revision: projects/{project}/locations/{location}/services/{service}/revisions/{revision}
- secret: projects/{project}/secrets/{secret}
- secretVersion: projects/{project}/secrets/{secret}/versions/{version}
- service: projects/{project}/locations/{location}/services/{service}
- workerPool: projects/{project}/locations/{location}/workerPools/{worker_pool}
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.
formattedName
string
The formatted name string
template
?string
Optional name of template to match
array