Google Cloud Resource Settings V1 Client - Class ResourceSettingsServiceClient (1.0.5)

Reference documentation and code samples for the Google Cloud Resource Settings V1 Client class ResourceSettingsServiceClient.

Service Description: An interface to interact with resource settings and setting values throughout the resource hierarchy.

Services may surface a number of settings for users to control how their resources behave. Values of settings applied on a given Cloud resource are evaluated hierarchically and inherited by all descendants of that resource.

For all requests, returns a google.rpc.Status with google.rpc.Code.PERMISSION_DENIED if the IAM check fails or the parent resource is not in a Cloud Organization. For all requests, returns a google.rpc.Status with google.rpc.Code.INVALID_ARGUMENT if the request is malformed.

This class provides the ability to make remote calls to the backing service through method calls that map to API methods. Sample code to get started:

$resourceSettingsServiceClient = new ResourceSettingsServiceClient();
try {
    $formattedName = $resourceSettingsServiceClient->settingName('[PROJECT_NUMBER]', '[SETTING_NAME]');
    $response = $resourceSettingsServiceClient->getSetting($formattedName);
} finally {
    $resourceSettingsServiceClient->close();
}

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

Methods

folderSettingNameName

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

Parameters
Name	Description
`folder`	`string`
`settingName`	`string`

Returns
Type	Description
`string`	The formatted folder_setting_name resource.

organizationSettingNameName

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

Parameters
Name	Description
`organization`	`string`
`settingName`	`string`

Returns
Type	Description
`string`	The formatted organization_setting_name resource.

projectNumberSettingNameName

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

Parameters
Name	Description
`projectNumber`	`string`
`settingName`	`string`

Returns
Type	Description
`string`	The formatted project_number_setting_name resource.

settingName

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

Parameters
Name	Description
`projectNumber`	`string`
`settingName`	`string`

Returns
Type	Description
`string`	The formatted setting resource.

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

folderSettingName: folders/{folder}/settings/{setting_name}
organizationSettingName: organizations/{organization}/settings/{setting_name}
projectNumberSettingName: projects/{project_number}/settings/{setting_name}
setting: projects/{project_number}/settings/{setting_name}

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.

__construct

Constructor.

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

getSetting

Gets a setting.

Returns a google.rpc.Status with google.rpc.Code.NOT_FOUND if the setting does not exist.

Parameters
Name	Description
`name`	`string` Required. The name of the setting to get. See Setting for naming requirements.
`optionalArgs`	`array` Optional.
`↳ view`	`int` The SettingView for this request. For allowed values, use constants defined on Google\Cloud\ResourceSettings\V1\SettingView
`↳ retrySettings`	`RetrySettings\|array` Retry settings to use for this call. Can be a Google\ApiCore\RetrySettings object, or an associative array of retry settings parameters. See the documentation on Google\ApiCore\RetrySettings for example usage.

Returns
Type	Description
`Google\Cloud\ResourceSettings\V1\Setting`

Example

use Google\ApiCore\ApiException;
use Google\Cloud\ResourceSettings\V1\ResourceSettingsServiceClient;
use Google\Cloud\ResourceSettings\V1\Setting;

/**
 * @param string $formattedName The name of the setting to get. See [Setting][google.cloud.resourcesettings.v1.Setting] for naming
 *                              requirements. Please see
 *                              {@see ResourceSettingsServiceClient::settingName()} for help formatting this field.
 */
function get_setting_sample(string $formattedName): void
{
    // Create a client.
    $resourceSettingsServiceClient = new ResourceSettingsServiceClient();

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

/**
 * 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 = ResourceSettingsServiceClient::settingName('[PROJECT_NUMBER]', '[SETTING_NAME]');

    get_setting_sample($formattedName);
}

listSettings

Lists all the settings that are available on the Cloud resource parent.

Parameters
Name	Description
`parent`	`string` Required. The Cloud resource that parents the setting. Must be in one of the following forms: `projects/{project_number}` `projects/{project_id}` `folders/{folder_id}` `organizations/{organization_id}`
`optionalArgs`	`array` Optional.
`↳ pageSize`	`int` The maximum number of resources contained in the underlying API response. The API may return fewer values in a page, even if there are additional values to be retrieved.
`↳ pageToken`	`string` A page token is used to specify a page of values to be returned. If no page token is specified (the default), the first page of values will be returned. Any page token used here must have been generated by a previous call to the API.
`↳ view`	`int` The SettingView for this request. For allowed values, use constants defined on Google\Cloud\ResourceSettings\V1\SettingView
`↳ retrySettings`	`RetrySettings\|array` Retry settings to use for this call. Can be a Google\ApiCore\RetrySettings object, or an associative array of retry settings parameters. See the documentation on Google\ApiCore\RetrySettings for example usage.

Returns
Type	Description
`Google\ApiCore\PagedListResponse`

Example

use Google\ApiCore\ApiException;
use Google\ApiCore\PagedListResponse;
use Google\Cloud\ResourceSettings\V1\ResourceSettingsServiceClient;
use Google\Cloud\ResourceSettings\V1\Setting;

/**
 * @param string $parent The Cloud resource that parents the setting. Must be in one of the
 *                       following forms:
 *
 *                       * `projects/{project_number}`
 *                       * `projects/{project_id}`
 *                       * `folders/{folder_id}`
 *                       * `organizations/{organization_id}`
 */
function list_settings_sample(string $parent): void
{
    // Create a client.
    $resourceSettingsServiceClient = new ResourceSettingsServiceClient();

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

        /** @var Setting $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());
    }
}

/**
 * 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
{
    $parent = '[PARENT]';

    list_settings_sample($parent);
}

updateSetting

Updates a setting.

Returns a google.rpc.Status with google.rpc.Code.NOT_FOUND if the setting does not exist. Returns a google.rpc.Status with google.rpc.Code.FAILED_PRECONDITION if the setting is flagged as read only. Returns a google.rpc.Status with google.rpc.Code.ABORTED if the etag supplied in the request does not match the persisted etag of the setting value.

On success, the response will contain only name, local_value and etag. The metadata and effective_value cannot be updated through this API.

Note: the supplied setting will perform a full overwrite of the local_value field.

Parameters
Name	Description
`setting`	`Google\Cloud\ResourceSettings\V1\Setting` Required. The setting to update. See Setting for field requirements.
`optionalArgs`	`array` Optional.
`↳ retrySettings`	`RetrySettings\|array` Retry settings to use for this call. Can be a Google\ApiCore\RetrySettings object, or an associative array of retry settings parameters. See the documentation on Google\ApiCore\RetrySettings for example usage.

Returns
Type	Description
`Google\Cloud\ResourceSettings\V1\Setting`

Example

use Google\ApiCore\ApiException;
use Google\Cloud\ResourceSettings\V1\ResourceSettingsServiceClient;
use Google\Cloud\ResourceSettings\V1\Setting;

/**
 * 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_setting_sample(): void
{
    // Create a client.
    $resourceSettingsServiceClient = new ResourceSettingsServiceClient();

    // Prepare any non-scalar elements to be passed along with the request.
    $setting = new Setting();

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

Constants

SERVICE_NAME

Value: 'google.cloud.resourcesettings.v1.ResourceSettingsService'

The name of the service.

SERVICE_ADDRESS

Value: 'resourcesettings.googleapis.com'

The default address of the service.

DEFAULT_SERVICE_PORT

Value: 443

The default port of the service.

CODEGEN_NAME

Value: 'gapic'

The name of the code generator, to be included in the agent header.