1. class
  2. Google
  3. \
  4. Service
  5. \
  6. ResourceSettings
  7. \
  8. Resource
  9. \
  10. ProjectsSettings

ProjectsSettings

class ProjectsSettings extends Resource (View source)

The "settings" collection of methods.

Typical usage is:

 $resourcesettingsService = new Google\Service\ResourceSettings(...);
 $settings = $resourcesettingsService->projects_settings;

Methods

GoogleCloudResourcesettingsV1Setting
get(string $name, array $optParams = [])

Returns a specified setting. Returns a google.rpc.Status with google.rpc.Code.NOT_FOUND if the setting does not exist. (settings.get)

GoogleCloudResourcesettingsV1ListSettingsResponse
listProjectsSettings(string $parent, array $optParams = [])

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

GoogleCloudResourcesettingsV1Setting
patch(string $name, GoogleCloudResourcesettingsV1Setting $postBody, array $optParams = [])

Updates a specified 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.

Details

at line 45
GoogleCloudResourcesettingsV1Setting get(string $name, array $optParams = [])

Returns a specified setting. Returns a google.rpc.Status with google.rpc.Code.NOT_FOUND if the setting does not exist. (settings.get)

Parameters

string $name

Required. The name of the setting to get. See Setting for naming requirements.
array $optParams

Optional parameters.

Return Value

GoogleCloudResourcesettingsV1Setting

Exceptions

Exception

at line 68
GoogleCloudResourcesettingsV1ListSettingsResponse listProjectsSettings(string $parent, array $optParams = [])

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

(settings.listProjectsSettings)

Parameters

string $parent

Required. The project, folder, or organization that is the parent resource for this setting. Must be in one of the following forms:

  • projects/{project_number} projects/{project_id} folders/{folder_id} * organizations/{organization_id}
array $optParams

Optional parameters.

Return Value

GoogleCloudResourcesettingsV1ListSettingsResponse

Exceptions

Exception

at line 96
GoogleCloudResourcesettingsV1Setting patch(string $name, GoogleCloudResourcesettingsV1Setting $postBody, array $optParams = [])

Updates a specified 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.

(settings.patch)

Parameters

string $name

The resource name of the setting. Must be in one of the following forms: projects/{project_number}/settings/{setting_name} folders/{folder_id}/settings/{setting_name} * organizations/{organization_id}/settings/{setting_name} For example, "/projects/123/settings/gcp-enableMyFeature"
GoogleCloudResourcesettingsV1Setting $postBody
array $optParams

Optional parameters.

Return Value

GoogleCloudResourcesettingsV1Setting

Exceptions

Exception