Reference documentation and code samples for the Google Cloud Saas Platform Saas Service Mgmt V1 Client class SaasDeploymentsClient.
Service Description: Manages the deployment of SaaS services.
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 \ SaasPlatform \ SaasServiceMgmt \ V1 \ ClientMethods
__construct
Constructor.
| Parameters | |
|---|---|
| Name | Description |
options |
array|Google\ApiCore\Options\ClientOptions
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 |
Google\Auth\FetchAuthTokenInterface|Google\ApiCore\CredentialsWrapper
This option should only be used with a pre-constructed Google\Auth\FetchAuthTokenInterface or Google\ApiCore\CredentialsWrapper object. Note that when one of these objects are provided, any settings in $credentialsConfig will be ignored. Important: If you are providing a path to a credentials file, or a decoded credentials file as a PHP array, this usage is now DEPRECATED. Providing an unvalidated credential configuration to Google APIs can compromise the security of your systems and data. It is recommended to create the credentials explicitly |
↳ 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|Google\ApiCore\Transport\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. |
↳ logger |
false|Psr\Log\LoggerInterface
A PSR-3 compliant logger. If set to false, logging is disabled, ignoring the 'GOOGLE_SDK_PHP_LOGGING' environment flag |
↳ universeDomain |
string
The service domain for the client. Defaults to 'googleapis.com'. |
createRelease
Create a new release.
The async variant is SaasDeploymentsClient::createReleaseAsync() .
| Parameters | |
|---|---|
| Name | Description |
request |
Google\Cloud\SaasPlatform\SaasServiceMgmt\V1\CreateReleaseRequest
A request to house fields associated with the call. |
callOptions |
array
Optional. |
↳ retrySettings |
Google\ApiCore\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\SaasPlatform\SaasServiceMgmt\V1\Release |
|
use Google\ApiCore\ApiException;
use Google\Cloud\SaasPlatform\SaasServiceMgmt\V1\Client\SaasDeploymentsClient;
use Google\Cloud\SaasPlatform\SaasServiceMgmt\V1\CreateReleaseRequest;
use Google\Cloud\SaasPlatform\SaasServiceMgmt\V1\Release;
/**
* @param string $formattedParent The parent of the release. Please see
* {@see SaasDeploymentsClient::locationName()} for help formatting this field.
* @param string $releaseId The ID value for the new release.
* @param string $formattedReleaseUnitKind Immutable. Reference to the UnitKind this Release corresponds to
* (required and immutable once created). Please see
* {@see SaasDeploymentsClient::unitKindName()} for help formatting this field.
*/
function create_release_sample(
string $formattedParent,
string $releaseId,
string $formattedReleaseUnitKind
): void {
// Create a client.
$saasDeploymentsClient = new SaasDeploymentsClient();
// Prepare the request message.
$release = (new Release())
->setUnitKind($formattedReleaseUnitKind);
$request = (new CreateReleaseRequest())
->setParent($formattedParent)
->setReleaseId($releaseId)
->setRelease($release);
// Call the API and handle any network failures.
try {
/** @var Release $response */
$response = $saasDeploymentsClient->createRelease($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 = SaasDeploymentsClient::locationName('[PROJECT]', '[LOCATION]');
$releaseId = '[RELEASE_ID]';
$formattedReleaseUnitKind = SaasDeploymentsClient::unitKindName(
'[PROJECT]',
'[LOCATION]',
'[UNIT_KIND]'
);
create_release_sample($formattedParent, $releaseId, $formattedReleaseUnitKind);
}
createSaas
Create a new saas.
The async variant is SaasDeploymentsClient::createSaasAsync() .
| Parameters | |
|---|---|
| Name | Description |
request |
Google\Cloud\SaasPlatform\SaasServiceMgmt\V1\CreateSaasRequest
A request to house fields associated with the call. |
callOptions |
array
Optional. |
↳ retrySettings |
Google\ApiCore\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\SaasPlatform\SaasServiceMgmt\V1\Saas |
|
use Google\ApiCore\ApiException;
use Google\Cloud\SaasPlatform\SaasServiceMgmt\V1\Client\SaasDeploymentsClient;
use Google\Cloud\SaasPlatform\SaasServiceMgmt\V1\CreateSaasRequest;
use Google\Cloud\SaasPlatform\SaasServiceMgmt\V1\Saas;
/**
* @param string $formattedParent The parent of the saas. Please see
* {@see SaasDeploymentsClient::locationName()} for help formatting this field.
* @param string $saasId The ID value for the new saas.
*/
function create_saas_sample(string $formattedParent, string $saasId): void
{
// Create a client.
$saasDeploymentsClient = new SaasDeploymentsClient();
// Prepare the request message.
$saas = new Saas();
$request = (new CreateSaasRequest())
->setParent($formattedParent)
->setSaasId($saasId)
->setSaas($saas);
// Call the API and handle any network failures.
try {
/** @var Saas $response */
$response = $saasDeploymentsClient->createSaas($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 = SaasDeploymentsClient::locationName('[PROJECT]', '[LOCATION]');
$saasId = '[SAAS_ID]';
create_saas_sample($formattedParent, $saasId);
}
createTenant
Create a new tenant.
The async variant is SaasDeploymentsClient::createTenantAsync() .
| Parameters | |
|---|---|
| Name | Description |
request |
Google\Cloud\SaasPlatform\SaasServiceMgmt\V1\CreateTenantRequest
A request to house fields associated with the call. |
callOptions |
array
Optional. |
↳ retrySettings |
Google\ApiCore\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\SaasPlatform\SaasServiceMgmt\V1\Tenant |
|
use Google\ApiCore\ApiException;
use Google\Cloud\SaasPlatform\SaasServiceMgmt\V1\Client\SaasDeploymentsClient;
use Google\Cloud\SaasPlatform\SaasServiceMgmt\V1\CreateTenantRequest;
use Google\Cloud\SaasPlatform\SaasServiceMgmt\V1\Tenant;
/**
* @param string $formattedParent The parent of the tenant. Please see
* {@see SaasDeploymentsClient::locationName()} for help formatting this field.
* @param string $tenantId The ID value for the new tenant.
* @param string $formattedTenantSaas Immutable. A reference to the Saas that defines the product
* (managed service) that the producer wants to manage with App Lifecycle
* Manager. Part of the App Lifecycle Manager common data model. Please see
* {@see SaasDeploymentsClient::saasName()} for help formatting this field.
*/
function create_tenant_sample(
string $formattedParent,
string $tenantId,
string $formattedTenantSaas
): void {
// Create a client.
$saasDeploymentsClient = new SaasDeploymentsClient();
// Prepare the request message.
$tenant = (new Tenant())
->setSaas($formattedTenantSaas);
$request = (new CreateTenantRequest())
->setParent($formattedParent)
->setTenantId($tenantId)
->setTenant($tenant);
// Call the API and handle any network failures.
try {
/** @var Tenant $response */
$response = $saasDeploymentsClient->createTenant($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 = SaasDeploymentsClient::locationName('[PROJECT]', '[LOCATION]');
$tenantId = '[TENANT_ID]';
$formattedTenantSaas = SaasDeploymentsClient::saasName('[PROJECT]', '[LOCATION]', '[SAAS]');
create_tenant_sample($formattedParent, $tenantId, $formattedTenantSaas);
}
createUnit
Create a new unit.
The async variant is SaasDeploymentsClient::createUnitAsync() .
| Parameters | |
|---|---|
| Name | Description |
request |
Google\Cloud\SaasPlatform\SaasServiceMgmt\V1\CreateUnitRequest
A request to house fields associated with the call. |
callOptions |
array
Optional. |
↳ retrySettings |
Google\ApiCore\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\SaasPlatform\SaasServiceMgmt\V1\Unit |
|
use Google\ApiCore\ApiException;
use Google\Cloud\SaasPlatform\SaasServiceMgmt\V1\Client\SaasDeploymentsClient;
use Google\Cloud\SaasPlatform\SaasServiceMgmt\V1\CreateUnitRequest;
use Google\Cloud\SaasPlatform\SaasServiceMgmt\V1\Unit;
/**
* @param string $formattedParent The parent of the unit. Please see
* {@see SaasDeploymentsClient::locationName()} for help formatting this field.
* @param string $unitId The ID value for the new unit.
*/
function create_unit_sample(string $formattedParent, string $unitId): void
{
// Create a client.
$saasDeploymentsClient = new SaasDeploymentsClient();
// Prepare the request message.
$unit = new Unit();
$request = (new CreateUnitRequest())
->setParent($formattedParent)
->setUnitId($unitId)
->setUnit($unit);
// Call the API and handle any network failures.
try {
/** @var Unit $response */
$response = $saasDeploymentsClient->createUnit($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 = SaasDeploymentsClient::locationName('[PROJECT]', '[LOCATION]');
$unitId = '[UNIT_ID]';
create_unit_sample($formattedParent, $unitId);
}
createUnitKind
Create a new unit kind.
The async variant is SaasDeploymentsClient::createUnitKindAsync() .
| Parameters | |
|---|---|
| Name | Description |
request |
Google\Cloud\SaasPlatform\SaasServiceMgmt\V1\CreateUnitKindRequest
A request to house fields associated with the call. |
callOptions |
array
Optional. |
↳ retrySettings |
Google\ApiCore\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\SaasPlatform\SaasServiceMgmt\V1\UnitKind |
|
use Google\ApiCore\ApiException;
use Google\Cloud\SaasPlatform\SaasServiceMgmt\V1\Client\SaasDeploymentsClient;
use Google\Cloud\SaasPlatform\SaasServiceMgmt\V1\CreateUnitKindRequest;
use Google\Cloud\SaasPlatform\SaasServiceMgmt\V1\UnitKind;
/**
* @param string $formattedParent The parent of the unit kind. Please see
* {@see SaasDeploymentsClient::locationName()} for help formatting this field.
* @param string $unitKindId The ID value for the new unit kind.
* @param string $formattedUnitKindSaas Immutable. A reference to the Saas that defines the product
* (managed service) that the producer wants to manage with App Lifecycle
* Manager. Part of the App Lifecycle Manager common data model. Immutable
* once set. Please see
* {@see SaasDeploymentsClient::saasName()} for help formatting this field.
*/
function create_unit_kind_sample(
string $formattedParent,
string $unitKindId,
string $formattedUnitKindSaas
): void {
// Create a client.
$saasDeploymentsClient = new SaasDeploymentsClient();
// Prepare the request message.
$unitKind = (new UnitKind())
->setSaas($formattedUnitKindSaas);
$request = (new CreateUnitKindRequest())
->setParent($formattedParent)
->setUnitKindId($unitKindId)
->setUnitKind($unitKind);
// Call the API and handle any network failures.
try {
/** @var UnitKind $response */
$response = $saasDeploymentsClient->createUnitKind($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 = SaasDeploymentsClient::locationName('[PROJECT]', '[LOCATION]');
$unitKindId = '[UNIT_KIND_ID]';
$formattedUnitKindSaas = SaasDeploymentsClient::saasName('[PROJECT]', '[LOCATION]', '[SAAS]');
create_unit_kind_sample($formattedParent, $unitKindId, $formattedUnitKindSaas);
}
createUnitOperation
Create a new unit operation.
The async variant is SaasDeploymentsClient::createUnitOperationAsync() .
| Parameters | |
|---|---|
| Name | Description |
request |
Google\Cloud\SaasPlatform\SaasServiceMgmt\V1\CreateUnitOperationRequest
A request to house fields associated with the call. |
callOptions |
array
Optional. |
↳ retrySettings |
Google\ApiCore\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\SaasPlatform\SaasServiceMgmt\V1\UnitOperation |
|
use Google\ApiCore\ApiException;
use Google\Cloud\SaasPlatform\SaasServiceMgmt\V1\Client\SaasDeploymentsClient;
use Google\Cloud\SaasPlatform\SaasServiceMgmt\V1\CreateUnitOperationRequest;
use Google\Cloud\SaasPlatform\SaasServiceMgmt\V1\UnitOperation;
/**
* @param string $formattedParent The parent of the unit operation. Please see
* {@see SaasDeploymentsClient::locationName()} for help formatting this field.
* @param string $unitOperationId The ID value for the new unit operation.
* @param string $formattedUnitOperationUnit Immutable. The Unit a given UnitOperation will act upon. Please see
* {@see SaasDeploymentsClient::unitName()} for help formatting this field.
*/
function create_unit_operation_sample(
string $formattedParent,
string $unitOperationId,
string $formattedUnitOperationUnit
): void {
// Create a client.
$saasDeploymentsClient = new SaasDeploymentsClient();
// Prepare the request message.
$unitOperation = (new UnitOperation())
->setUnit($formattedUnitOperationUnit);
$request = (new CreateUnitOperationRequest())
->setParent($formattedParent)
->setUnitOperationId($unitOperationId)
->setUnitOperation($unitOperation);
// Call the API and handle any network failures.
try {
/** @var UnitOperation $response */
$response = $saasDeploymentsClient->createUnitOperation($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 = SaasDeploymentsClient::locationName('[PROJECT]', '[LOCATION]');
$unitOperationId = '[UNIT_OPERATION_ID]';
$formattedUnitOperationUnit = SaasDeploymentsClient::unitName('[PROJECT]', '[LOCATION]', '[UNIT]');
create_unit_operation_sample($formattedParent, $unitOperationId, $formattedUnitOperationUnit);
}
deleteRelease
Delete a single release.
The async variant is SaasDeploymentsClient::deleteReleaseAsync() .
| Parameters | |
|---|---|
| Name | Description |
request |
Google\Cloud\SaasPlatform\SaasServiceMgmt\V1\DeleteReleaseRequest
A request to house fields associated with the call. |
callOptions |
array
Optional. |
↳ retrySettings |
Google\ApiCore\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\SaasPlatform\SaasServiceMgmt\V1\Client\SaasDeploymentsClient;
use Google\Cloud\SaasPlatform\SaasServiceMgmt\V1\DeleteReleaseRequest;
/**
* @param string $formattedName The resource name of the resource within a service. Please see
* {@see SaasDeploymentsClient::releaseName()} for help formatting this field.
*/
function delete_release_sample(string $formattedName): void
{
// Create a client.
$saasDeploymentsClient = new SaasDeploymentsClient();
// Prepare the request message.
$request = (new DeleteReleaseRequest())
->setName($formattedName);
// Call the API and handle any network failures.
try {
$saasDeploymentsClient->deleteRelease($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 = SaasDeploymentsClient::releaseName('[PROJECT]', '[LOCATION]', '[RELEASE]');
delete_release_sample($formattedName);
}
deleteSaas
Delete a single saas.
The async variant is SaasDeploymentsClient::deleteSaasAsync() .
| Parameters | |
|---|---|
| Name | Description |
request |
Google\Cloud\SaasPlatform\SaasServiceMgmt\V1\DeleteSaasRequest
A request to house fields associated with the call. |
callOptions |
array
Optional. |
↳ retrySettings |
Google\ApiCore\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\SaasPlatform\SaasServiceMgmt\V1\Client\SaasDeploymentsClient;
use Google\Cloud\SaasPlatform\SaasServiceMgmt\V1\DeleteSaasRequest;
/**
* @param string $formattedName The resource name of the resource within a service. Please see
* {@see SaasDeploymentsClient::saasName()} for help formatting this field.
*/
function delete_saas_sample(string $formattedName): void
{
// Create a client.
$saasDeploymentsClient = new SaasDeploymentsClient();
// Prepare the request message.
$request = (new DeleteSaasRequest())
->setName($formattedName);
// Call the API and handle any network failures.
try {
$saasDeploymentsClient->deleteSaas($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 = SaasDeploymentsClient::saasName('[PROJECT]', '[LOCATION]', '[SAAS]');
delete_saas_sample($formattedName);
}
deleteTenant
Delete a single tenant.
The async variant is SaasDeploymentsClient::deleteTenantAsync() .
| Parameters | |
|---|---|
| Name | Description |
request |
Google\Cloud\SaasPlatform\SaasServiceMgmt\V1\DeleteTenantRequest
A request to house fields associated with the call. |
callOptions |
array
Optional. |
↳ retrySettings |
Google\ApiCore\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\SaasPlatform\SaasServiceMgmt\V1\Client\SaasDeploymentsClient;
use Google\Cloud\SaasPlatform\SaasServiceMgmt\V1\DeleteTenantRequest;
/**
* @param string $formattedName The resource name of the resource within a service. Please see
* {@see SaasDeploymentsClient::tenantName()} for help formatting this field.
*/
function delete_tenant_sample(string $formattedName): void
{
// Create a client.
$saasDeploymentsClient = new SaasDeploymentsClient();
// Prepare the request message.
$request = (new DeleteTenantRequest())
->setName($formattedName);
// Call the API and handle any network failures.
try {
$saasDeploymentsClient->deleteTenant($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 = SaasDeploymentsClient::tenantName('[PROJECT]', '[LOCATION]', '[TENANT]');
delete_tenant_sample($formattedName);
}
deleteUnit
Delete a single unit.
The async variant is SaasDeploymentsClient::deleteUnitAsync() .
| Parameters | |
|---|---|
| Name | Description |
request |
Google\Cloud\SaasPlatform\SaasServiceMgmt\V1\DeleteUnitRequest
A request to house fields associated with the call. |
callOptions |
array
Optional. |
↳ retrySettings |
Google\ApiCore\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\SaasPlatform\SaasServiceMgmt\V1\Client\SaasDeploymentsClient;
use Google\Cloud\SaasPlatform\SaasServiceMgmt\V1\DeleteUnitRequest;
/**
* @param string $formattedName The resource name of the resource within a service. Please see
* {@see SaasDeploymentsClient::unitName()} for help formatting this field.
*/
function delete_unit_sample(string $formattedName): void
{
// Create a client.
$saasDeploymentsClient = new SaasDeploymentsClient();
// Prepare the request message.
$request = (new DeleteUnitRequest())
->setName($formattedName);
// Call the API and handle any network failures.
try {
$saasDeploymentsClient->deleteUnit($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 = SaasDeploymentsClient::unitName('[PROJECT]', '[LOCATION]', '[UNIT]');
delete_unit_sample($formattedName);
}
deleteUnitKind
Delete a single unit kind.
The async variant is SaasDeploymentsClient::deleteUnitKindAsync() .
| Parameters | |
|---|---|
| Name | Description |
request |
Google\Cloud\SaasPlatform\SaasServiceMgmt\V1\DeleteUnitKindRequest
A request to house fields associated with the call. |
callOptions |
array
Optional. |
↳ retrySettings |
Google\ApiCore\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\SaasPlatform\SaasServiceMgmt\V1\Client\SaasDeploymentsClient;
use Google\Cloud\SaasPlatform\SaasServiceMgmt\V1\DeleteUnitKindRequest;
/**
* @param string $formattedName The resource name of the resource within a service. Please see
* {@see SaasDeploymentsClient::unitKindName()} for help formatting this field.
*/
function delete_unit_kind_sample(string $formattedName): void
{
// Create a client.
$saasDeploymentsClient = new SaasDeploymentsClient();
// Prepare the request message.
$request = (new DeleteUnitKindRequest())
->setName($formattedName);
// Call the API and handle any network failures.
try {
$saasDeploymentsClient->deleteUnitKind($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 = SaasDeploymentsClient::unitKindName('[PROJECT]', '[LOCATION]', '[UNIT_KIND]');
delete_unit_kind_sample($formattedName);
}
deleteUnitOperation
Delete a single unit operation.
The async variant is SaasDeploymentsClient::deleteUnitOperationAsync() .
| Parameters | |
|---|---|
| Name | Description |
request |
Google\Cloud\SaasPlatform\SaasServiceMgmt\V1\DeleteUnitOperationRequest
A request to house fields associated with the call. |
callOptions |
array
Optional. |
↳ retrySettings |
Google\ApiCore\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\SaasPlatform\SaasServiceMgmt\V1\Client\SaasDeploymentsClient;
use Google\Cloud\SaasPlatform\SaasServiceMgmt\V1\DeleteUnitOperationRequest;
/**
* @param string $formattedName The resource name of the resource within a service. Please see
* {@see SaasDeploymentsClient::unitOperationName()} for help formatting this field.
*/
function delete_unit_operation_sample(string $formattedName): void
{
// Create a client.
$saasDeploymentsClient = new SaasDeploymentsClient();
// Prepare the request message.
$request = (new DeleteUnitOperationRequest())
->setName($formattedName);
// Call the API and handle any network failures.
try {
$saasDeploymentsClient->deleteUnitOperation($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 = SaasDeploymentsClient::unitOperationName(
'[PROJECT]',
'[LOCATION]',
'[UNIT_OPERATION]'
);
delete_unit_operation_sample($formattedName);
}
getRelease
Retrieve a single release.
The async variant is SaasDeploymentsClient::getReleaseAsync() .
| Parameters | |
|---|---|
| Name | Description |
request |
Google\Cloud\SaasPlatform\SaasServiceMgmt\V1\GetReleaseRequest
A request to house fields associated with the call. |
callOptions |
array
Optional. |
↳ retrySettings |
Google\ApiCore\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\SaasPlatform\SaasServiceMgmt\V1\Release |
|
use Google\ApiCore\ApiException;
use Google\Cloud\SaasPlatform\SaasServiceMgmt\V1\Client\SaasDeploymentsClient;
use Google\Cloud\SaasPlatform\SaasServiceMgmt\V1\GetReleaseRequest;
use Google\Cloud\SaasPlatform\SaasServiceMgmt\V1\Release;
/**
* @param string $formattedName The resource name of the resource within a service. Please see
* {@see SaasDeploymentsClient::releaseName()} for help formatting this field.
*/
function get_release_sample(string $formattedName): void
{
// Create a client.
$saasDeploymentsClient = new SaasDeploymentsClient();
// Prepare the request message.
$request = (new GetReleaseRequest())
->setName($formattedName);
// Call the API and handle any network failures.
try {
/** @var Release $response */
$response = $saasDeploymentsClient->getRelease($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 = SaasDeploymentsClient::releaseName('[PROJECT]', '[LOCATION]', '[RELEASE]');
get_release_sample($formattedName);
}
getSaas
Retrieve a single saas.
The async variant is SaasDeploymentsClient::getSaasAsync() .
| Parameters | |
|---|---|
| Name | Description |
request |
Google\Cloud\SaasPlatform\SaasServiceMgmt\V1\GetSaasRequest
A request to house fields associated with the call. |
callOptions |
array
Optional. |
↳ retrySettings |
Google\ApiCore\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\SaasPlatform\SaasServiceMgmt\V1\Saas |
|
use Google\ApiCore\ApiException;
use Google\Cloud\SaasPlatform\SaasServiceMgmt\V1\Client\SaasDeploymentsClient;
use Google\Cloud\SaasPlatform\SaasServiceMgmt\V1\GetSaasRequest;
use Google\Cloud\SaasPlatform\SaasServiceMgmt\V1\Saas;
/**
* @param string $formattedName The resource name of the resource within a service. Please see
* {@see SaasDeploymentsClient::saasName()} for help formatting this field.
*/
function get_saas_sample(string $formattedName): void
{
// Create a client.
$saasDeploymentsClient = new SaasDeploymentsClient();
// Prepare the request message.
$request = (new GetSaasRequest())
->setName($formattedName);
// Call the API and handle any network failures.
try {
/** @var Saas $response */
$response = $saasDeploymentsClient->getSaas($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 = SaasDeploymentsClient::saasName('[PROJECT]', '[LOCATION]', '[SAAS]');
get_saas_sample($formattedName);
}
getTenant
Retrieve a single tenant.
The async variant is SaasDeploymentsClient::getTenantAsync() .
| Parameters | |
|---|---|
| Name | Description |
request |
Google\Cloud\SaasPlatform\SaasServiceMgmt\V1\GetTenantRequest
A request to house fields associated with the call. |
callOptions |
array
Optional. |
↳ retrySettings |
Google\ApiCore\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\SaasPlatform\SaasServiceMgmt\V1\Tenant |
|
use Google\ApiCore\ApiException;
use Google\Cloud\SaasPlatform\SaasServiceMgmt\V1\Client\SaasDeploymentsClient;
use Google\Cloud\SaasPlatform\SaasServiceMgmt\V1\GetTenantRequest;
use Google\Cloud\SaasPlatform\SaasServiceMgmt\V1\Tenant;
/**
* @param string $formattedName The resource name of the resource within a service. Please see
* {@see SaasDeploymentsClient::tenantName()} for help formatting this field.
*/
function get_tenant_sample(string $formattedName): void
{
// Create a client.
$saasDeploymentsClient = new SaasDeploymentsClient();
// Prepare the request message.
$request = (new GetTenantRequest())
->setName($formattedName);
// Call the API and handle any network failures.
try {
/** @var Tenant $response */
$response = $saasDeploymentsClient->getTenant($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 = SaasDeploymentsClient::tenantName('[PROJECT]', '[LOCATION]', '[TENANT]');
get_tenant_sample($formattedName);
}
getUnit
Retrieve a single unit.
The async variant is SaasDeploymentsClient::getUnitAsync() .
| Parameters | |
|---|---|
| Name | Description |
request |
Google\Cloud\SaasPlatform\SaasServiceMgmt\V1\GetUnitRequest
A request to house fields associated with the call. |
callOptions |
array
Optional. |
↳ retrySettings |
Google\ApiCore\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\SaasPlatform\SaasServiceMgmt\V1\Unit |
|
use Google\ApiCore\ApiException;
use Google\Cloud\SaasPlatform\SaasServiceMgmt\V1\Client\SaasDeploymentsClient;
use Google\Cloud\SaasPlatform\SaasServiceMgmt\V1\GetUnitRequest;
use Google\Cloud\SaasPlatform\SaasServiceMgmt\V1\Unit;
/**
* @param string $formattedName The resource name of the resource within a service. Please see
* {@see SaasDeploymentsClient::unitName()} for help formatting this field.
*/
function get_unit_sample(string $formattedName): void
{
// Create a client.
$saasDeploymentsClient = new SaasDeploymentsClient();
// Prepare the request message.
$request = (new GetUnitRequest())
->setName($formattedName);
// Call the API and handle any network failures.
try {
/** @var Unit $response */
$response = $saasDeploymentsClient->getUnit($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 = SaasDeploymentsClient::unitName('[PROJECT]', '[LOCATION]', '[UNIT]');
get_unit_sample($formattedName);
}
getUnitKind
Retrieve a single unit kind.
The async variant is SaasDeploymentsClient::getUnitKindAsync() .
| Parameters | |
|---|---|
| Name | Description |
request |
Google\Cloud\SaasPlatform\SaasServiceMgmt\V1\GetUnitKindRequest
A request to house fields associated with the call. |
callOptions |
array
Optional. |
↳ retrySettings |
Google\ApiCore\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\SaasPlatform\SaasServiceMgmt\V1\UnitKind |
|
use Google\ApiCore\ApiException;
use Google\Cloud\SaasPlatform\SaasServiceMgmt\V1\Client\SaasDeploymentsClient;
use Google\Cloud\SaasPlatform\SaasServiceMgmt\V1\GetUnitKindRequest;
use Google\Cloud\SaasPlatform\SaasServiceMgmt\V1\UnitKind;
/**
* @param string $formattedName The resource name of the resource within a service. Please see
* {@see SaasDeploymentsClient::unitKindName()} for help formatting this field.
*/
function get_unit_kind_sample(string $formattedName): void
{
// Create a client.
$saasDeploymentsClient = new SaasDeploymentsClient();
// Prepare the request message.
$request = (new GetUnitKindRequest())
->setName($formattedName);
// Call the API and handle any network failures.
try {
/** @var UnitKind $response */
$response = $saasDeploymentsClient->getUnitKind($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 = SaasDeploymentsClient::unitKindName('[PROJECT]', '[LOCATION]', '[UNIT_KIND]');
get_unit_kind_sample($formattedName);
}
getUnitOperation
Retrieve a single unit operation.
The async variant is SaasDeploymentsClient::getUnitOperationAsync() .
| Parameters | |
|---|---|
| Name | Description |
request |
Google\Cloud\SaasPlatform\SaasServiceMgmt\V1\GetUnitOperationRequest
A request to house fields associated with the call. |
callOptions |
array
Optional. |
↳ retrySettings |
Google\ApiCore\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\SaasPlatform\SaasServiceMgmt\V1\UnitOperation |
|
use Google\ApiCore\ApiException;
use Google\Cloud\SaasPlatform\SaasServiceMgmt\V1\Client\SaasDeploymentsClient;
use Google\Cloud\SaasPlatform\SaasServiceMgmt\V1\GetUnitOperationRequest;
use Google\Cloud\SaasPlatform\SaasServiceMgmt\V1\UnitOperation;
/**
* @param string $formattedName The resource name of the resource within a service. Please see
* {@see SaasDeploymentsClient::unitOperationName()} for help formatting this field.
*/
function get_unit_operation_sample(string $formattedName): void
{
// Create a client.
$saasDeploymentsClient = new SaasDeploymentsClient();
// Prepare the request message.
$request = (new GetUnitOperationRequest())
->setName($formattedName);
// Call the API and handle any network failures.
try {
/** @var UnitOperation $response */
$response = $saasDeploymentsClient->getUnitOperation($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 = SaasDeploymentsClient::unitOperationName(
'[PROJECT]',
'[LOCATION]',
'[UNIT_OPERATION]'
);
get_unit_operation_sample($formattedName);
}
listReleases
Retrieve a collection of releases.
The async variant is SaasDeploymentsClient::listReleasesAsync() .
| Parameters | |
|---|---|
| Name | Description |
request |
Google\Cloud\SaasPlatform\SaasServiceMgmt\V1\ListReleasesRequest
A request to house fields associated with the call. |
callOptions |
array
Optional. |
↳ retrySettings |
Google\ApiCore\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\SaasPlatform\SaasServiceMgmt\V1\Client\SaasDeploymentsClient;
use Google\Cloud\SaasPlatform\SaasServiceMgmt\V1\ListReleasesRequest;
use Google\Cloud\SaasPlatform\SaasServiceMgmt\V1\Release;
/**
* @param string $formattedParent The parent of the release. Please see
* {@see SaasDeploymentsClient::locationName()} for help formatting this field.
*/
function list_releases_sample(string $formattedParent): void
{
// Create a client.
$saasDeploymentsClient = new SaasDeploymentsClient();
// Prepare the request message.
$request = (new ListReleasesRequest())
->setParent($formattedParent);
// Call the API and handle any network failures.
try {
/** @var PagedListResponse $response */
$response = $saasDeploymentsClient->listReleases($request);
/** @var Release $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 = SaasDeploymentsClient::locationName('[PROJECT]', '[LOCATION]');
list_releases_sample($formattedParent);
}
listSaas
Retrieve a collection of saas.
The async variant is SaasDeploymentsClient::listSaasAsync() .
| Parameters | |
|---|---|
| Name | Description |
request |
Google\Cloud\SaasPlatform\SaasServiceMgmt\V1\ListSaasRequest
A request to house fields associated with the call. |
callOptions |
array
Optional. |
↳ retrySettings |
Google\ApiCore\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\SaasPlatform\SaasServiceMgmt\V1\Client\SaasDeploymentsClient;
use Google\Cloud\SaasPlatform\SaasServiceMgmt\V1\ListSaasRequest;
use Google\Cloud\SaasPlatform\SaasServiceMgmt\V1\Saas;
/**
* @param string $formattedParent The parent of the saas. Please see
* {@see SaasDeploymentsClient::locationName()} for help formatting this field.
*/
function list_saas_sample(string $formattedParent): void
{
// Create a client.
$saasDeploymentsClient = new SaasDeploymentsClient();
// Prepare the request message.
$request = (new ListSaasRequest())
->setParent($formattedParent);
// Call the API and handle any network failures.
try {
/** @var PagedListResponse $response */
$response = $saasDeploymentsClient->listSaas($request);
/** @var Saas $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 = SaasDeploymentsClient::locationName('[PROJECT]', '[LOCATION]');
list_saas_sample($formattedParent);
}
listTenants
Retrieve a collection of tenants.
The async variant is SaasDeploymentsClient::listTenantsAsync() .
| Parameters | |
|---|---|
| Name | Description |
request |
Google\Cloud\SaasPlatform\SaasServiceMgmt\V1\ListTenantsRequest
A request to house fields associated with the call. |
callOptions |
array
Optional. |
↳ retrySettings |
Google\ApiCore\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\SaasPlatform\SaasServiceMgmt\V1\Client\SaasDeploymentsClient;
use Google\Cloud\SaasPlatform\SaasServiceMgmt\V1\ListTenantsRequest;
use Google\Cloud\SaasPlatform\SaasServiceMgmt\V1\Tenant;
/**
* @param string $formattedParent The parent of the tenant. Please see
* {@see SaasDeploymentsClient::locationName()} for help formatting this field.
*/
function list_tenants_sample(string $formattedParent): void
{
// Create a client.
$saasDeploymentsClient = new SaasDeploymentsClient();
// Prepare the request message.
$request = (new ListTenantsRequest())
->setParent($formattedParent);
// Call the API and handle any network failures.
try {
/** @var PagedListResponse $response */
$response = $saasDeploymentsClient->listTenants($request);
/** @var Tenant $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 = SaasDeploymentsClient::locationName('[PROJECT]', '[LOCATION]');
list_tenants_sample($formattedParent);
}
listUnitKinds
Retrieve a collection of unit kinds.
The async variant is SaasDeploymentsClient::listUnitKindsAsync() .
| Parameters | |
|---|---|
| Name | Description |
request |
Google\Cloud\SaasPlatform\SaasServiceMgmt\V1\ListUnitKindsRequest
A request to house fields associated with the call. |
callOptions |
array
Optional. |
↳ retrySettings |
Google\ApiCore\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\SaasPlatform\SaasServiceMgmt\V1\Client\SaasDeploymentsClient;
use Google\Cloud\SaasPlatform\SaasServiceMgmt\V1\ListUnitKindsRequest;
use Google\Cloud\SaasPlatform\SaasServiceMgmt\V1\UnitKind;
/**
* @param string $formattedParent The parent of the unit kind. Please see
* {@see SaasDeploymentsClient::locationName()} for help formatting this field.
*/
function list_unit_kinds_sample(string $formattedParent): void
{
// Create a client.
$saasDeploymentsClient = new SaasDeploymentsClient();
// Prepare the request message.
$request = (new ListUnitKindsRequest())
->setParent($formattedParent);
// Call the API and handle any network failures.
try {
/** @var PagedListResponse $response */
$response = $saasDeploymentsClient->listUnitKinds($request);
/** @var UnitKind $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 = SaasDeploymentsClient::locationName('[PROJECT]', '[LOCATION]');
list_unit_kinds_sample($formattedParent);
}
listUnitOperations
Retrieve a collection of unit operations.
The async variant is SaasDeploymentsClient::listUnitOperationsAsync() .
| Parameters | |
|---|---|
| Name | Description |
request |
Google\Cloud\SaasPlatform\SaasServiceMgmt\V1\ListUnitOperationsRequest
A request to house fields associated with the call. |
callOptions |
array
Optional. |
↳ retrySettings |
Google\ApiCore\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\SaasPlatform\SaasServiceMgmt\V1\Client\SaasDeploymentsClient;
use Google\Cloud\SaasPlatform\SaasServiceMgmt\V1\ListUnitOperationsRequest;
use Google\Cloud\SaasPlatform\SaasServiceMgmt\V1\UnitOperation;
/**
* @param string $formattedParent The parent of the unit operation. Please see
* {@see SaasDeploymentsClient::locationName()} for help formatting this field.
*/
function list_unit_operations_sample(string $formattedParent): void
{
// Create a client.
$saasDeploymentsClient = new SaasDeploymentsClient();
// Prepare the request message.
$request = (new ListUnitOperationsRequest())
->setParent($formattedParent);
// Call the API and handle any network failures.
try {
/** @var PagedListResponse $response */
$response = $saasDeploymentsClient->listUnitOperations($request);
/** @var UnitOperation $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 = SaasDeploymentsClient::locationName('[PROJECT]', '[LOCATION]');
list_unit_operations_sample($formattedParent);
}
listUnits
Retrieve a collection of units.
The async variant is SaasDeploymentsClient::listUnitsAsync() .
| Parameters | |
|---|---|
| Name | Description |
request |
Google\Cloud\SaasPlatform\SaasServiceMgmt\V1\ListUnitsRequest
A request to house fields associated with the call. |
callOptions |
array
Optional. |
↳ retrySettings |
Google\ApiCore\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\SaasPlatform\SaasServiceMgmt\V1\Client\SaasDeploymentsClient;
use Google\Cloud\SaasPlatform\SaasServiceMgmt\V1\ListUnitsRequest;
use Google\Cloud\SaasPlatform\SaasServiceMgmt\V1\Unit;
/**
* @param string $formattedParent The parent of the unit. Please see
* {@see SaasDeploymentsClient::locationName()} for help formatting this field.
*/
function list_units_sample(string $formattedParent): void
{
// Create a client.
$saasDeploymentsClient = new SaasDeploymentsClient();
// Prepare the request message.
$request = (new ListUnitsRequest())
->setParent($formattedParent);
// Call the API and handle any network failures.
try {
/** @var PagedListResponse $response */
$response = $saasDeploymentsClient->listUnits($request);
/** @var Unit $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 = SaasDeploymentsClient::locationName('[PROJECT]', '[LOCATION]');
list_units_sample($formattedParent);
}
updateRelease
Update a single release.
The async variant is SaasDeploymentsClient::updateReleaseAsync() .
| Parameters | |
|---|---|
| Name | Description |
request |
Google\Cloud\SaasPlatform\SaasServiceMgmt\V1\UpdateReleaseRequest
A request to house fields associated with the call. |
callOptions |
array
Optional. |
↳ retrySettings |
Google\ApiCore\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\SaasPlatform\SaasServiceMgmt\V1\Release |
|
use Google\ApiCore\ApiException;
use Google\Cloud\SaasPlatform\SaasServiceMgmt\V1\Client\SaasDeploymentsClient;
use Google\Cloud\SaasPlatform\SaasServiceMgmt\V1\Release;
use Google\Cloud\SaasPlatform\SaasServiceMgmt\V1\UpdateReleaseRequest;
/**
* @param string $formattedReleaseUnitKind Immutable. Reference to the UnitKind this Release corresponds to
* (required and immutable once created). Please see
* {@see SaasDeploymentsClient::unitKindName()} for help formatting this field.
*/
function update_release_sample(string $formattedReleaseUnitKind): void
{
// Create a client.
$saasDeploymentsClient = new SaasDeploymentsClient();
// Prepare the request message.
$release = (new Release())
->setUnitKind($formattedReleaseUnitKind);
$request = (new UpdateReleaseRequest())
->setRelease($release);
// Call the API and handle any network failures.
try {
/** @var Release $response */
$response = $saasDeploymentsClient->updateRelease($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
{
$formattedReleaseUnitKind = SaasDeploymentsClient::unitKindName(
'[PROJECT]',
'[LOCATION]',
'[UNIT_KIND]'
);
update_release_sample($formattedReleaseUnitKind);
}
updateSaas
Update a single saas.
The async variant is SaasDeploymentsClient::updateSaasAsync() .
| Parameters | |
|---|---|
| Name | Description |
request |
Google\Cloud\SaasPlatform\SaasServiceMgmt\V1\UpdateSaasRequest
A request to house fields associated with the call. |
callOptions |
array
Optional. |
↳ retrySettings |
Google\ApiCore\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\SaasPlatform\SaasServiceMgmt\V1\Saas |
|
use Google\ApiCore\ApiException;
use Google\Cloud\SaasPlatform\SaasServiceMgmt\V1\Client\SaasDeploymentsClient;
use Google\Cloud\SaasPlatform\SaasServiceMgmt\V1\Saas;
use Google\Cloud\SaasPlatform\SaasServiceMgmt\V1\UpdateSaasRequest;
/**
* 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_saas_sample(): void
{
// Create a client.
$saasDeploymentsClient = new SaasDeploymentsClient();
// Prepare the request message.
$saas = new Saas();
$request = (new UpdateSaasRequest())
->setSaas($saas);
// Call the API and handle any network failures.
try {
/** @var Saas $response */
$response = $saasDeploymentsClient->updateSaas($request);
printf('Response data: %s' . PHP_EOL, $response->serializeToJsonString());
} catch (ApiException $ex) {
printf('Call failed with message: %s' . PHP_EOL, $ex->getMessage());
}
}
updateTenant
Update a single tenant.
The async variant is SaasDeploymentsClient::updateTenantAsync() .
| Parameters | |
|---|---|
| Name | Description |
request |
Google\Cloud\SaasPlatform\SaasServiceMgmt\V1\UpdateTenantRequest
A request to house fields associated with the call. |
callOptions |
array
Optional. |
↳ retrySettings |
Google\ApiCore\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\SaasPlatform\SaasServiceMgmt\V1\Tenant |
|
use Google\ApiCore\ApiException;
use Google\Cloud\SaasPlatform\SaasServiceMgmt\V1\Client\SaasDeploymentsClient;
use Google\Cloud\SaasPlatform\SaasServiceMgmt\V1\Tenant;
use Google\Cloud\SaasPlatform\SaasServiceMgmt\V1\UpdateTenantRequest;
/**
* @param string $formattedTenantSaas Immutable. A reference to the Saas that defines the product
* (managed service) that the producer wants to manage with App Lifecycle
* Manager. Part of the App Lifecycle Manager common data model. Please see
* {@see SaasDeploymentsClient::saasName()} for help formatting this field.
*/
function update_tenant_sample(string $formattedTenantSaas): void
{
// Create a client.
$saasDeploymentsClient = new SaasDeploymentsClient();
// Prepare the request message.
$tenant = (new Tenant())
->setSaas($formattedTenantSaas);
$request = (new UpdateTenantRequest())
->setTenant($tenant);
// Call the API and handle any network failures.
try {
/** @var Tenant $response */
$response = $saasDeploymentsClient->updateTenant($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
{
$formattedTenantSaas = SaasDeploymentsClient::saasName('[PROJECT]', '[LOCATION]', '[SAAS]');
update_tenant_sample($formattedTenantSaas);
}
updateUnit
Update a single unit.
The async variant is SaasDeploymentsClient::updateUnitAsync() .
| Parameters | |
|---|---|
| Name | Description |
request |
Google\Cloud\SaasPlatform\SaasServiceMgmt\V1\UpdateUnitRequest
A request to house fields associated with the call. |
callOptions |
array
Optional. |
↳ retrySettings |
Google\ApiCore\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\SaasPlatform\SaasServiceMgmt\V1\Unit |
|
use Google\ApiCore\ApiException;
use Google\Cloud\SaasPlatform\SaasServiceMgmt\V1\Client\SaasDeploymentsClient;
use Google\Cloud\SaasPlatform\SaasServiceMgmt\V1\Unit;
use Google\Cloud\SaasPlatform\SaasServiceMgmt\V1\UpdateUnitRequest;
/**
* 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_unit_sample(): void
{
// Create a client.
$saasDeploymentsClient = new SaasDeploymentsClient();
// Prepare the request message.
$unit = new Unit();
$request = (new UpdateUnitRequest())
->setUnit($unit);
// Call the API and handle any network failures.
try {
/** @var Unit $response */
$response = $saasDeploymentsClient->updateUnit($request);
printf('Response data: %s' . PHP_EOL, $response->serializeToJsonString());
} catch (ApiException $ex) {
printf('Call failed with message: %s' . PHP_EOL, $ex->getMessage());
}
}
updateUnitKind
Update a single unit kind.
The async variant is SaasDeploymentsClient::updateUnitKindAsync() .
| Parameters | |
|---|---|
| Name | Description |
request |
Google\Cloud\SaasPlatform\SaasServiceMgmt\V1\UpdateUnitKindRequest
A request to house fields associated with the call. |
callOptions |
array
Optional. |
↳ retrySettings |
Google\ApiCore\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\SaasPlatform\SaasServiceMgmt\V1\UnitKind |
|
use Google\ApiCore\ApiException;
use Google\Cloud\SaasPlatform\SaasServiceMgmt\V1\Client\SaasDeploymentsClient;
use Google\Cloud\SaasPlatform\SaasServiceMgmt\V1\UnitKind;
use Google\Cloud\SaasPlatform\SaasServiceMgmt\V1\UpdateUnitKindRequest;
/**
* @param string $formattedUnitKindSaas Immutable. A reference to the Saas that defines the product
* (managed service) that the producer wants to manage with App Lifecycle
* Manager. Part of the App Lifecycle Manager common data model. Immutable
* once set. Please see
* {@see SaasDeploymentsClient::saasName()} for help formatting this field.
*/
function update_unit_kind_sample(string $formattedUnitKindSaas): void
{
// Create a client.
$saasDeploymentsClient = new SaasDeploymentsClient();
// Prepare the request message.
$unitKind = (new UnitKind())
->setSaas($formattedUnitKindSaas);
$request = (new UpdateUnitKindRequest())
->setUnitKind($unitKind);
// Call the API and handle any network failures.
try {
/** @var UnitKind $response */
$response = $saasDeploymentsClient->updateUnitKind($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
{
$formattedUnitKindSaas = SaasDeploymentsClient::saasName('[PROJECT]', '[LOCATION]', '[SAAS]');
update_unit_kind_sample($formattedUnitKindSaas);
}
updateUnitOperation
Update a single unit operation.
The async variant is SaasDeploymentsClient::updateUnitOperationAsync() .
| Parameters | |
|---|---|
| Name | Description |
request |
Google\Cloud\SaasPlatform\SaasServiceMgmt\V1\UpdateUnitOperationRequest
A request to house fields associated with the call. |
callOptions |
array
Optional. |
↳ retrySettings |
Google\ApiCore\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\SaasPlatform\SaasServiceMgmt\V1\UnitOperation |
|
use Google\ApiCore\ApiException;
use Google\Cloud\SaasPlatform\SaasServiceMgmt\V1\Client\SaasDeploymentsClient;
use Google\Cloud\SaasPlatform\SaasServiceMgmt\V1\UnitOperation;
use Google\Cloud\SaasPlatform\SaasServiceMgmt\V1\UpdateUnitOperationRequest;
/**
* @param string $formattedUnitOperationUnit Immutable. The Unit a given UnitOperation will act upon. Please see
* {@see SaasDeploymentsClient::unitName()} for help formatting this field.
*/
function update_unit_operation_sample(string $formattedUnitOperationUnit): void
{
// Create a client.
$saasDeploymentsClient = new SaasDeploymentsClient();
// Prepare the request message.
$unitOperation = (new UnitOperation())
->setUnit($formattedUnitOperationUnit);
$request = (new UpdateUnitOperationRequest())
->setUnitOperation($unitOperation);
// Call the API and handle any network failures.
try {
/** @var UnitOperation $response */
$response = $saasDeploymentsClient->updateUnitOperation($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
{
$formattedUnitOperationUnit = SaasDeploymentsClient::unitName('[PROJECT]', '[LOCATION]', '[UNIT]');
update_unit_operation_sample($formattedUnitOperationUnit);
}
getLocation
Gets information about a location.
The async variant is SaasDeploymentsClient::getLocationAsync() .
| Parameters | |
|---|---|
| Name | Description |
request |
Google\Cloud\Location\GetLocationRequest
A request to house fields associated with the call. |
callOptions |
array
Optional. |
↳ retrySettings |
Google\ApiCore\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 |
|
use Google\ApiCore\ApiException;
use Google\Cloud\Location\GetLocationRequest;
use Google\Cloud\Location\Location;
use Google\Cloud\SaasPlatform\SaasServiceMgmt\V1\Client\SaasDeploymentsClient;
/**
* 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.
$saasDeploymentsClient = new SaasDeploymentsClient();
// Prepare the request message.
$request = new GetLocationRequest();
// Call the API and handle any network failures.
try {
/** @var Location $response */
$response = $saasDeploymentsClient->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.
This method lists locations based on the resource scope provided in
the ListLocationsRequest.name field: *
Global locations: If name is empty, the method lists the
public locations available to all projects. * Project-specific
locations: If name follows the format
projects/{project}, the method lists locations visible to that
specific project. This includes public, private, or other
project-specific locations enabled for the project.
For gRPC and client library implementations, the resource name is
passed as the name field. For direct service calls, the resource
name is
incorporated into the request path based on the specific service
implementation and version.
The async variant is SaasDeploymentsClient::listLocationsAsync() .
| Parameters | |
|---|---|
| Name | Description |
request |
Google\Cloud\Location\ListLocationsRequest
A request to house fields associated with the call. |
callOptions |
array
Optional. |
↳ retrySettings |
Google\ApiCore\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\Location\ListLocationsRequest;
use Google\Cloud\Location\Location;
use Google\Cloud\SaasPlatform\SaasServiceMgmt\V1\Client\SaasDeploymentsClient;
/**
* 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.
$saasDeploymentsClient = new SaasDeploymentsClient();
// Prepare the request message.
$request = new ListLocationsRequest();
// Call the API and handle any network failures.
try {
/** @var PagedListResponse $response */
$response = $saasDeploymentsClient->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());
}
}
createReleaseAsync
| Parameters | |
|---|---|
| Name | Description |
request |
Google\Cloud\SaasPlatform\SaasServiceMgmt\V1\CreateReleaseRequest
|
optionalArgs |
array
|
| Returns | |
|---|---|
| Type | Description |
GuzzleHttp\Promise\PromiseInterface<Google\Cloud\SaasPlatform\SaasServiceMgmt\V1\Release> |
|
createSaasAsync
| Parameters | |
|---|---|
| Name | Description |
request |
Google\Cloud\SaasPlatform\SaasServiceMgmt\V1\CreateSaasRequest
|
optionalArgs |
array
|
| Returns | |
|---|---|
| Type | Description |
GuzzleHttp\Promise\PromiseInterface<Google\Cloud\SaasPlatform\SaasServiceMgmt\V1\Saas> |
|
createTenantAsync
| Parameters | |
|---|---|
| Name | Description |
request |
Google\Cloud\SaasPlatform\SaasServiceMgmt\V1\CreateTenantRequest
|
optionalArgs |
array
|
| Returns | |
|---|---|
| Type | Description |
GuzzleHttp\Promise\PromiseInterface<Google\Cloud\SaasPlatform\SaasServiceMgmt\V1\Tenant> |
|
createUnitAsync
| Parameters | |
|---|---|
| Name | Description |
request |
Google\Cloud\SaasPlatform\SaasServiceMgmt\V1\CreateUnitRequest
|
optionalArgs |
array
|
| Returns | |
|---|---|
| Type | Description |
GuzzleHttp\Promise\PromiseInterface<Google\Cloud\SaasPlatform\SaasServiceMgmt\V1\Unit> |
|
createUnitKindAsync
| Parameters | |
|---|---|
| Name | Description |
request |
Google\Cloud\SaasPlatform\SaasServiceMgmt\V1\CreateUnitKindRequest
|
optionalArgs |
array
|
| Returns | |
|---|---|
| Type | Description |
GuzzleHttp\Promise\PromiseInterface<Google\Cloud\SaasPlatform\SaasServiceMgmt\V1\UnitKind> |
|
createUnitOperationAsync
| Parameters | |
|---|---|
| Name | Description |
request |
Google\Cloud\SaasPlatform\SaasServiceMgmt\V1\CreateUnitOperationRequest
|
optionalArgs |
array
|
| Returns | |
|---|---|
| Type | Description |
GuzzleHttp\Promise\PromiseInterface<Google\Cloud\SaasPlatform\SaasServiceMgmt\V1\UnitOperation> |
|
deleteReleaseAsync
| Parameters | |
|---|---|
| Name | Description |
request |
Google\Cloud\SaasPlatform\SaasServiceMgmt\V1\DeleteReleaseRequest
|
optionalArgs |
array
|
| Returns | |
|---|---|
| Type | Description |
GuzzleHttp\Promise\PromiseInterface<void> |
|
deleteSaasAsync
| Parameters | |
|---|---|
| Name | Description |
request |
Google\Cloud\SaasPlatform\SaasServiceMgmt\V1\DeleteSaasRequest
|
optionalArgs |
array
|
| Returns | |
|---|---|
| Type | Description |
GuzzleHttp\Promise\PromiseInterface<void> |
|
deleteTenantAsync
| Parameters | |
|---|---|
| Name | Description |
request |
Google\Cloud\SaasPlatform\SaasServiceMgmt\V1\DeleteTenantRequest
|
optionalArgs |
array
|
| Returns | |
|---|---|
| Type | Description |
GuzzleHttp\Promise\PromiseInterface<void> |
|
deleteUnitAsync
| Parameters | |
|---|---|
| Name | Description |
request |
Google\Cloud\SaasPlatform\SaasServiceMgmt\V1\DeleteUnitRequest
|
optionalArgs |
array
|
| Returns | |
|---|---|
| Type | Description |
GuzzleHttp\Promise\PromiseInterface<void> |
|
deleteUnitKindAsync
| Parameters | |
|---|---|
| Name | Description |
request |
Google\Cloud\SaasPlatform\SaasServiceMgmt\V1\DeleteUnitKindRequest
|
optionalArgs |
array
|
| Returns | |
|---|---|
| Type | Description |
GuzzleHttp\Promise\PromiseInterface<void> |
|
deleteUnitOperationAsync
| Parameters | |
|---|---|
| Name | Description |
request |
Google\Cloud\SaasPlatform\SaasServiceMgmt\V1\DeleteUnitOperationRequest
|
optionalArgs |
array
|
| Returns | |
|---|---|
| Type | Description |
GuzzleHttp\Promise\PromiseInterface<void> |
|
getReleaseAsync
| Parameters | |
|---|---|
| Name | Description |
request |
Google\Cloud\SaasPlatform\SaasServiceMgmt\V1\GetReleaseRequest
|
optionalArgs |
array
|
| Returns | |
|---|---|
| Type | Description |
GuzzleHttp\Promise\PromiseInterface<Google\Cloud\SaasPlatform\SaasServiceMgmt\V1\Release> |
|
getSaasAsync
| Parameters | |
|---|---|
| Name | Description |
request |
Google\Cloud\SaasPlatform\SaasServiceMgmt\V1\GetSaasRequest
|
optionalArgs |
array
|
| Returns | |
|---|---|
| Type | Description |
GuzzleHttp\Promise\PromiseInterface<Google\Cloud\SaasPlatform\SaasServiceMgmt\V1\Saas> |
|
getTenantAsync
| Parameters | |
|---|---|
| Name | Description |
request |
Google\Cloud\SaasPlatform\SaasServiceMgmt\V1\GetTenantRequest
|
optionalArgs |
array
|
| Returns | |
|---|---|
| Type | Description |
GuzzleHttp\Promise\PromiseInterface<Google\Cloud\SaasPlatform\SaasServiceMgmt\V1\Tenant> |
|
getUnitAsync
| Parameters | |
|---|---|
| Name | Description |
request |
Google\Cloud\SaasPlatform\SaasServiceMgmt\V1\GetUnitRequest
|
optionalArgs |
array
|
| Returns | |
|---|---|
| Type | Description |
GuzzleHttp\Promise\PromiseInterface<Google\Cloud\SaasPlatform\SaasServiceMgmt\V1\Unit> |
|
getUnitKindAsync
| Parameters | |
|---|---|
| Name | Description |
request |
Google\Cloud\SaasPlatform\SaasServiceMgmt\V1\GetUnitKindRequest
|
optionalArgs |
array
|
| Returns | |
|---|---|
| Type | Description |
GuzzleHttp\Promise\PromiseInterface<Google\Cloud\SaasPlatform\SaasServiceMgmt\V1\UnitKind> |
|
getUnitOperationAsync
| Parameters | |
|---|---|
| Name | Description |
request |
Google\Cloud\SaasPlatform\SaasServiceMgmt\V1\GetUnitOperationRequest
|
optionalArgs |
array
|
| Returns | |
|---|---|
| Type | Description |
GuzzleHttp\Promise\PromiseInterface<Google\Cloud\SaasPlatform\SaasServiceMgmt\V1\UnitOperation> |
|
listReleasesAsync
| Parameters | |
|---|---|
| Name | Description |
request |
Google\Cloud\SaasPlatform\SaasServiceMgmt\V1\ListReleasesRequest
|
optionalArgs |
array
|
| Returns | |
|---|---|
| Type | Description |
GuzzleHttp\Promise\PromiseInterface<Google\ApiCore\PagedListResponse> |
|
listSaasAsync
| Parameters | |
|---|---|
| Name | Description |
request |
Google\Cloud\SaasPlatform\SaasServiceMgmt\V1\ListSaasRequest
|
optionalArgs |
array
|
| Returns | |
|---|---|
| Type | Description |
GuzzleHttp\Promise\PromiseInterface<Google\ApiCore\PagedListResponse> |
|
listTenantsAsync
| Parameters | |
|---|---|
| Name | Description |
request |
Google\Cloud\SaasPlatform\SaasServiceMgmt\V1\ListTenantsRequest
|
optionalArgs |
array
|
| Returns | |
|---|---|
| Type | Description |
GuzzleHttp\Promise\PromiseInterface<Google\ApiCore\PagedListResponse> |
|
listUnitKindsAsync
| Parameters | |
|---|---|
| Name | Description |
request |
Google\Cloud\SaasPlatform\SaasServiceMgmt\V1\ListUnitKindsRequest
|
optionalArgs |
array
|
| Returns | |
|---|---|
| Type | Description |
GuzzleHttp\Promise\PromiseInterface<Google\ApiCore\PagedListResponse> |
|
listUnitOperationsAsync
| Parameters | |
|---|---|
| Name | Description |
request |
Google\Cloud\SaasPlatform\SaasServiceMgmt\V1\ListUnitOperationsRequest
|
optionalArgs |
array
|
| Returns | |
|---|---|
| Type | Description |
GuzzleHttp\Promise\PromiseInterface<Google\ApiCore\PagedListResponse> |
|
listUnitsAsync
| Parameters | |
|---|---|
| Name | Description |
request |
Google\Cloud\SaasPlatform\SaasServiceMgmt\V1\ListUnitsRequest
|
optionalArgs |
array
|
| Returns | |
|---|---|
| Type | Description |
GuzzleHttp\Promise\PromiseInterface<Google\ApiCore\PagedListResponse> |
|
updateReleaseAsync
| Parameters | |
|---|---|
| Name | Description |
request |
Google\Cloud\SaasPlatform\SaasServiceMgmt\V1\UpdateReleaseRequest
|
optionalArgs |
array
|
| Returns | |
|---|---|
| Type | Description |
GuzzleHttp\Promise\PromiseInterface<Google\Cloud\SaasPlatform\SaasServiceMgmt\V1\Release> |
|
updateSaasAsync
| Parameters | |
|---|---|
| Name | Description |
request |
Google\Cloud\SaasPlatform\SaasServiceMgmt\V1\UpdateSaasRequest
|
optionalArgs |
array
|
| Returns | |
|---|---|
| Type | Description |
GuzzleHttp\Promise\PromiseInterface<Google\Cloud\SaasPlatform\SaasServiceMgmt\V1\Saas> |
|
updateTenantAsync
| Parameters | |
|---|---|
| Name | Description |
request |
Google\Cloud\SaasPlatform\SaasServiceMgmt\V1\UpdateTenantRequest
|
optionalArgs |
array
|
| Returns | |
|---|---|
| Type | Description |
GuzzleHttp\Promise\PromiseInterface<Google\Cloud\SaasPlatform\SaasServiceMgmt\V1\Tenant> |
|
updateUnitAsync
| Parameters | |
|---|---|
| Name | Description |
request |
Google\Cloud\SaasPlatform\SaasServiceMgmt\V1\UpdateUnitRequest
|
optionalArgs |
array
|
| Returns | |
|---|---|
| Type | Description |
GuzzleHttp\Promise\PromiseInterface<Google\Cloud\SaasPlatform\SaasServiceMgmt\V1\Unit> |
|
updateUnitKindAsync
| Parameters | |
|---|---|
| Name | Description |
request |
Google\Cloud\SaasPlatform\SaasServiceMgmt\V1\UpdateUnitKindRequest
|
optionalArgs |
array
|
| Returns | |
|---|---|
| Type | Description |
GuzzleHttp\Promise\PromiseInterface<Google\Cloud\SaasPlatform\SaasServiceMgmt\V1\UnitKind> |
|
updateUnitOperationAsync
| Parameters | |
|---|---|
| Name | Description |
request |
Google\Cloud\SaasPlatform\SaasServiceMgmt\V1\UpdateUnitOperationRequest
|
optionalArgs |
array
|
| Returns | |
|---|---|
| Type | Description |
GuzzleHttp\Promise\PromiseInterface<Google\Cloud\SaasPlatform\SaasServiceMgmt\V1\UnitOperation> |
|
getLocationAsync
| Parameters | |
|---|---|
| Name | Description |
request |
Google\Cloud\Location\GetLocationRequest
|
optionalArgs |
array
|
| Returns | |
|---|---|
| Type | Description |
GuzzleHttp\Promise\PromiseInterface<Google\Cloud\Location\Location> |
|
listLocationsAsync
| Parameters | |
|---|---|
| Name | Description |
request |
Google\Cloud\Location\ListLocationsRequest
|
optionalArgs |
array
|
| Returns | |
|---|---|
| Type | Description |
GuzzleHttp\Promise\PromiseInterface<Google\ApiCore\PagedListResponse> |
|
static::applicationName
Formats a string containing the fully-qualified path to represent a application resource.
| Parameters | |
|---|---|
| Name | Description |
project |
string
|
location |
string
|
application |
string
|
| Returns | |
|---|---|
| Type | Description |
string |
The formatted application resource. |
static::applicationTemplateName
Formats a string containing the fully-qualified path to represent a application_template resource.
| Parameters | |
|---|---|
| Name | Description |
project |
string
|
location |
string
|
space |
string
|
applicationTemplate |
string
|
| Returns | |
|---|---|
| Type | Description |
string |
The formatted application_template resource. |
static::applicationTemplateRevisionName
Formats a string containing the fully-qualified path to represent a application_template_revision resource.
| Parameters | |
|---|---|
| Name | Description |
project |
string
|
location |
string
|
space |
string
|
applicationTemplate |
string
|
revision |
string
|
| Returns | |
|---|---|
| Type | Description |
string |
The formatted application_template_revision 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::projectLocationSpaceApplicationTemplateName
Formats a string containing the fully-qualified path to represent a project_location_space_application_template resource.
| Parameters | |
|---|---|
| Name | Description |
project |
string
|
location |
string
|
space |
string
|
applicationTemplate |
string
|
| Returns | |
|---|---|
| Type | Description |
string |
The formatted project_location_space_application_template resource. |
static::projectLocationWorkspaceApplicationTemplateName
Formats a string containing the fully-qualified path to represent a project_location_workspace_application_template resource.
| Parameters | |
|---|---|
| Name | Description |
project |
string
|
location |
string
|
workspace |
string
|
applicationTemplate |
string
|
| Returns | |
|---|---|
| Type | Description |
string |
The formatted project_location_workspace_application_template resource. |
static::releaseName
Formats a string containing the fully-qualified path to represent a release resource.
| Parameters | |
|---|---|
| Name | Description |
project |
string
|
location |
string
|
release |
string
|
| Returns | |
|---|---|
| Type | Description |
string |
The formatted release resource. |
static::rolloutName
Formats a string containing the fully-qualified path to represent a rollout resource.
| Parameters | |
|---|---|
| Name | Description |
project |
string
|
location |
string
|
rolloutId |
string
|
| Returns | |
|---|---|
| Type | Description |
string |
The formatted rollout resource. |
static::saasName
Formats a string containing the fully-qualified path to represent a saas resource.
| Parameters | |
|---|---|
| Name | Description |
project |
string
|
location |
string
|
saas |
string
|
| Returns | |
|---|---|
| Type | Description |
string |
The formatted saas resource. |
static::tenantName
Formats a string containing the fully-qualified path to represent a tenant resource.
| Parameters | |
|---|---|
| Name | Description |
project |
string
|
location |
string
|
tenant |
string
|
| Returns | |
|---|---|
| Type | Description |
string |
The formatted tenant resource. |
static::unitName
Formats a string containing the fully-qualified path to represent a unit resource.
| Parameters | |
|---|---|
| Name | Description |
project |
string
|
location |
string
|
unit |
string
|
| Returns | |
|---|---|
| Type | Description |
string |
The formatted unit resource. |
static::unitKindName
Formats a string containing the fully-qualified path to represent a unit_kind resource.
| Parameters | |
|---|---|
| Name | Description |
project |
string
|
location |
string
|
unitKind |
string
|
| Returns | |
|---|---|
| Type | Description |
string |
The formatted unit_kind resource. |
static::unitOperationName
Formats a string containing the fully-qualified path to represent a unit_operation resource.
| Parameters | |
|---|---|
| Name | Description |
project |
string
|
location |
string
|
unitOperation |
string
|
| Returns | |
|---|---|
| Type | Description |
string |
The formatted unit_operation 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
- application: projects/{project}/locations/{location}/applications/{application}
- applicationTemplate: projects/{project}/locations/{location}/spaces/{space}/applicationTemplates/{application_template}
- applicationTemplateRevision: projects/{project}/locations/{location}/spaces/{space}/applicationTemplates/{application_template}/revisions/{revision}
- location: projects/{project}/locations/{location}
- projectLocationSpaceApplicationTemplate: projects/{project}/locations/{location}/spaces/{space}/applicationTemplates/{application_template}
- projectLocationWorkspaceApplicationTemplate: projects/{project}/locations/{location}/workspaces/{workspace}/applicationTemplates/{application_template}
- release: projects/{project}/locations/{location}/releases/{release}
- rollout: projects/{project}/locations/{location}/rollouts/{rollout_id}
- saas: projects/{project}/locations/{location}/saas/{saas}
- tenant: projects/{project}/locations/{location}/tenants/{tenant}
- unit: projects/{project}/locations/{location}/units/{unit}
- unitKind: projects/{project}/locations/{location}/unitKinds/{unit_kind}
- unitOperation: projects/{project}/locations/{location}/unitOperations/{unit_operation}
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. |