Resource Settings API (resourcesettings:v1)

Deletions

Methods


• ▼ ▲ resourcesettings.projects.settings.get

  Description : Returns a specified setting. Returns a `google.rpc.Status` with `google.rpc.Code.NOT_FOUND` if the setting does not exist.

  Path : v1/{+name}

  HTTP Method : GET

  Parameter Order : name

  Flat Path : v1/projects/{projectsId}/settings/{settingsId}

  Parameters :

  name

  Required : Yes

  Pattern : ^projects/[^/]+/settings/[^/]+$

  Type : string

  Location : path

  Description : Required. The name of the setting to get. See Setting for naming requirements.

  view

  Type : string

  Description : The SettingView for this request.

  Enum Descriptions :

  • The default / unset value. The API will default to the SETTING_VIEW_BASIC view.
  • Include Setting.metadata, but nothing else. This is the default value (for both ListSettings and GetSetting).
  • Include Setting.effective_value, but nothing else.
  • Include Setting.local_value, but nothing else.

  Location : query

  Enum :

  • SETTING_VIEW_UNSPECIFIED
  • SETTING_VIEW_BASIC
  • SETTING_VIEW_EFFECTIVE_VALUE
  • SETTING_VIEW_LOCAL_VALUE

  Deprecated : Yes

  Scopes : https://www.googleapis.com/auth/cloud-platform

• ▼ ▲ resourcesettings.projects.settings.list

  Path : v1/{+parent}/settings

  Flat Path : v1/projects/{projectsId}/settings

  HTTP Method : GET

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

  Scopes : https://www.googleapis.com/auth/cloud-platform

  Parameter Order : parent

  Parameters :

  pageSize

  Location : query

  Description : Unused. The size of the page to be returned.

  Format : int32

  Type : integer

  parent

  Description : 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}`

  Type : string

  Required : Yes

  Location : path

  Pattern : ^projects/[^/]+$

  pageToken

  Description : Unused. A page token used to retrieve the next page.

  Location : query

  Type : string

  view

  Location : query

  Enum :

  • SETTING_VIEW_UNSPECIFIED
  • SETTING_VIEW_BASIC
  • SETTING_VIEW_EFFECTIVE_VALUE
  • SETTING_VIEW_LOCAL_VALUE

  Description : The SettingView for this request.

  Enum Descriptions :

  • The default / unset value. The API will default to the SETTING_VIEW_BASIC view.
  • Include Setting.metadata, but nothing else. This is the default value (for both ListSettings and GetSetting).
  • Include Setting.effective_value, but nothing else.
  • Include Setting.local_value, but nothing else.

  Type : string

  Deprecated : Yes

• ▼ ▲ resourcesettings.projects.settings.patch

  Parameters :

  name

  Description : 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"

  Type : string

  Required : Yes

  Location : path

  Pattern : ^projects/[^/]+/settings/[^/]+$

  Scopes : https://www.googleapis.com/auth/cloud-platform

  Flat Path : v1/projects/{projectsId}/settings/{settingsId}

  Parameter Order : name

  Deprecated : Yes

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

  HTTP Method : PATCH

  Path : v1/{+name}

• ▼ ▲ resourcesettings.organizations.settings.get

  Description : Returns a specified setting. Returns a `google.rpc.Status` with `google.rpc.Code.NOT_FOUND` if the setting does not exist.

  Scopes : https://www.googleapis.com/auth/cloud-platform

  Path : v1/{+name}

  Flat Path : v1/organizations/{organizationsId}/settings/{settingsId}

  Deprecated : Yes

  Parameter Order : name

  HTTP Method : GET

  Parameters :

  view

  Enum :

  • SETTING_VIEW_UNSPECIFIED
  • SETTING_VIEW_BASIC
  • SETTING_VIEW_EFFECTIVE_VALUE
  • SETTING_VIEW_LOCAL_VALUE

  Type : string

  Enum Descriptions :

  • The default / unset value. The API will default to the SETTING_VIEW_BASIC view.
  • Include Setting.metadata, but nothing else. This is the default value (for both ListSettings and GetSetting).
  • Include Setting.effective_value, but nothing else.
  • Include Setting.local_value, but nothing else.

  Location : query

  Description : The SettingView for this request.

  name

  Location : path

  Required : Yes

  Description : Required. The name of the setting to get. See Setting for naming requirements.

  Pattern : ^organizations/[^/]+/settings/[^/]+$

  Type : string

• ▼ ▲ resourcesettings.organizations.settings.list

  HTTP Method : GET

  Scopes : https://www.googleapis.com/auth/cloud-platform

  Flat Path : v1/organizations/{organizationsId}/settings

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

  Path : v1/{+parent}/settings

  Deprecated : Yes

  Parameter Order : parent

  Parameters :

  parent

  Location : path

  Required : Yes

  Description : 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}`

  Pattern : ^organizations/[^/]+$

  Type : string

  pageToken

  Type : string

  Location : query

  Description : Unused. A page token used to retrieve the next page.

  pageSize

  Location : query

  Format : int32

  Description : Unused. The size of the page to be returned.

  Type : integer

  view

  Enum Descriptions :

  • The default / unset value. The API will default to the SETTING_VIEW_BASIC view.
  • Include Setting.metadata, but nothing else. This is the default value (for both ListSettings and GetSetting).
  • Include Setting.effective_value, but nothing else.
  • Include Setting.local_value, but nothing else.

  Description : The SettingView for this request.

  Location : query

  Type : string

  Enum :

  • SETTING_VIEW_UNSPECIFIED
  • SETTING_VIEW_BASIC
  • SETTING_VIEW_EFFECTIVE_VALUE
  • SETTING_VIEW_LOCAL_VALUE

• ▼ ▲ resourcesettings.organizations.settings.patch

  Flat Path : v1/organizations/{organizationsId}/settings/{settingsId}

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

  Deprecated : Yes

  Parameter Order : name

  Path : v1/{+name}

  HTTP Method : PATCH

  Parameters :

  name

  Type : string

  Pattern : ^organizations/[^/]+/settings/[^/]+$

  Description : 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"

  Location : path

  Required : Yes

  Scopes : https://www.googleapis.com/auth/cloud-platform

• ▼ ▲ resourcesettings.folders.settings.get

  Parameter Order : name

  Scopes : https://www.googleapis.com/auth/cloud-platform

  Deprecated : Yes

  Description : Returns a specified setting. Returns a `google.rpc.Status` with `google.rpc.Code.NOT_FOUND` if the setting does not exist.

  HTTP Method : GET

  Parameters :

  name

  Location : path

  Type : string

  Description : Required. The name of the setting to get. See Setting for naming requirements.

  Required : Yes

  Pattern : ^folders/[^/]+/settings/[^/]+$

  view

  Description : The SettingView for this request.

  Enum :

  • SETTING_VIEW_UNSPECIFIED
  • SETTING_VIEW_BASIC
  • SETTING_VIEW_EFFECTIVE_VALUE
  • SETTING_VIEW_LOCAL_VALUE

  Type : string

  Location : query

  Enum Descriptions :

  • The default / unset value. The API will default to the SETTING_VIEW_BASIC view.
  • Include Setting.metadata, but nothing else. This is the default value (for both ListSettings and GetSetting).
  • Include Setting.effective_value, but nothing else.
  • Include Setting.local_value, but nothing else.

  Flat Path : v1/folders/{foldersId}/settings/{settingsId}

  Path : v1/{+name}

• ▼ ▲ resourcesettings.folders.settings.patch

  Flat Path : v1/folders/{foldersId}/settings/{settingsId}

  Path : v1/{+name}

  Parameters :

  name

  Required : Yes

  Description : 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"

  Location : path

  Type : string

  Pattern : ^folders/[^/]+/settings/[^/]+$

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

  HTTP Method : PATCH

  Scopes : https://www.googleapis.com/auth/cloud-platform

  Deprecated : Yes

  Parameter Order : name

• ▼ ▲ resourcesettings.folders.settings.list

  Parameters :

  pageToken

  Type : string

  Location : query

  Description : Unused. A page token used to retrieve the next page.

  pageSize

  Location : query

  Type : integer

  Format : int32

  Description : Unused. The size of the page to be returned.

  parent

  Pattern : ^folders/[^/]+$

  Description : 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}`

  Required : Yes

  Type : string

  Location : path

  view

  Enum Descriptions :

  • The default / unset value. The API will default to the SETTING_VIEW_BASIC view.
  • Include Setting.metadata, but nothing else. This is the default value (for both ListSettings and GetSetting).
  • Include Setting.effective_value, but nothing else.
  • Include Setting.local_value, but nothing else.

  Location : query

  Description : The SettingView for this request.

  Type : string

  Enum :

  • SETTING_VIEW_UNSPECIFIED
  • SETTING_VIEW_BASIC
  • SETTING_VIEW_EFFECTIVE_VALUE
  • SETTING_VIEW_LOCAL_VALUE

  Flat Path : v1/folders/{foldersId}/settings

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

  Scopes : https://www.googleapis.com/auth/cloud-platform

  Path : v1/{+parent}/settings

  Deprecated : Yes

  Parameter Order : parent

  HTTP Method : GET