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

Version 1.1.3

• 2.0.2 (latest)
• 2.0.1
• 1.2.6
• 1.1.3
• 1.0.5

Beta

This library is covered by the Pre-GA Offerings Terms of the Terms of Service. Pre-GA libraries might have limited support, and changes to pre-GA libraries might not be compatible with other pre-GA versions. For more information, see the launch stage descriptions.

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.

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

This class is currently experimental and may be subject to changes. See Google\Cloud\ResourceSettings\V1\ResourceSettingsServiceClient for the stable implementation

Namespace

Google \ Cloud \ ResourceSettings \ V1 \ Client

Methods

__construct

Constructor.

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

getSetting

Gets a setting.

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

The async variant is Google\Cloud\ResourceSettings\V1\Client\ResourceSettingsServiceClient::getSettingAsync() .

Parameters
Name	Description
request	Google\Cloud\ResourceSettings\V1\GetSettingRequest A request to house fields associated with the call.
callOptions	array Optional.
↳ retrySettings	RetrySettings|array Retry settings to use for this call. Can be a Google\ApiCore\RetrySettings object, or an associative array of retry settings parameters. See the documentation on Google\ApiCore\RetrySettings for example usage.

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

listSettings

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

The async variant is Google\Cloud\ResourceSettings\V1\Client\ResourceSettingsServiceClient::listSettingsAsync() .

Parameters
Name	Description
request	Google\Cloud\ResourceSettings\V1\ListSettingsRequest A request to house fields associated with the call.
callOptions	array Optional.
↳ retrySettings	RetrySettings|array Retry settings to use for this call. Can be a Google\ApiCore\RetrySettings object, or an associative array of retry settings parameters. See the documentation on Google\ApiCore\RetrySettings for example usage.

Returns
Type	Description
Google\ApiCore\PagedListResponse

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.

The async variant is Google\Cloud\ResourceSettings\V1\Client\ResourceSettingsServiceClient::updateSettingAsync() .

Parameters
Name	Description
request	Google\Cloud\ResourceSettings\V1\UpdateSettingRequest A request to house fields associated with the call.
callOptions	array Optional.
↳ retrySettings	RetrySettings|array Retry settings to use for this call. Can be a Google\ApiCore\RetrySettings object, or an associative array of retry settings parameters. See the documentation on Google\ApiCore\RetrySettings for example usage.

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

getSettingAsync

Parameters
Name	Description
request	Google\Cloud\ResourceSettings\V1\GetSettingRequest
optionalArgs = []	array

Returns
Type	Description
GuzzleHttp\Promise\PromiseInterface

listSettingsAsync

Parameters
Name	Description
request	Google\Cloud\ResourceSettings\V1\ListSettingsRequest
optionalArgs = []	array

Returns
Type	Description
GuzzleHttp\Promise\PromiseInterface

updateSettingAsync

Parameters
Name	Description
request	Google\Cloud\ResourceSettings\V1\UpdateSettingRequest
optionalArgs = []	array

Returns
Type	Description
GuzzleHttp\Promise\PromiseInterface

static::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.

static::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.

static::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.

static::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.

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

• 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.