REST Resource: projects.settings
Stay organized with collections
Save and categorize content based on your preferences.
Resource: Setting
The schema for setting values. At a given Cloud resource, a setting can parent at most one setting value.
JSON representation |
{
"name": string,
"displayName": string,
"description": string,
"readOnly": boolean,
"dataType": enum (DataType ),
"defaultValue": {
object (Value )
}
} |
Fields |
name |
string
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"
|
displayName |
string
The human readable name for this setting.
|
description |
string
A detailed description of what this setting does.
|
readOnly |
boolean
A flag indicating that values of this setting cannot be modified (see documentation of the specific setting for updates and reasons); however, it may be deleted using settings.deleteValue if DeleteSettingValueRequest.ignore_read_only is set to true. Using this flag is considered an acknowledgement that the setting value cannot be recreated. See DeleteSettingValueRequest.ignore_read_only for more details.
|
dataType |
enum (DataType )
The data type for this setting.
|
defaultValue |
object (Value )
The value received by settings.lookupEffectiveValue if no setting value is explicitly set. Note: not all settings have a default value.
|
Methods |
|
Deletes a setting value. |
|
Gets a setting value. |
|
Lists all the settings that are available on the Cloud resource parent . |
|
Computes the effective setting value of a setting at the Cloud resource parent . |
|
Searches for all setting values that exist on the resource parent . |
|
Updates a setting value. |
Except as otherwise noted, the content of this page is licensed under the Creative Commons Attribution 4.0 License, and code samples are licensed under the Apache 2.0 License. For details, see the Google Developers Site Policies. Java is a registered trademark of Oracle and/or its affiliates.
Last updated 2023-05-25 UTC.
[[["Easy to understand","easyToUnderstand","thumb-up"],["Solved my problem","solvedMyProblem","thumb-up"],["Other","otherUp","thumb-up"]],[["Missing the information I need","missingTheInformationINeed","thumb-down"],["Too complicated / too many steps","tooComplicatedTooManySteps","thumb-down"],["Out of date","outOfDate","thumb-down"],["Samples / code issue","samplesCodeIssue","thumb-down"],["Other","otherDown","thumb-down"]],["Last updated 2023-05-25 UTC."],[[["This document describes the `Setting` resource, which defines the schema for setting values within Cloud resources."],["Settings have properties like name, display name, description, data type, and a default value."],["A setting can have at most one value associated with it at a given Cloud resource."],["Several methods are available to interact with settings and their values, including getting, setting, listing, searching, and deleting."],["The `Setting` resource allows for configuring and managing various aspects of Cloud resources using a structured approach."]]],["The \"Setting\" resource defines the schema for setting values in Cloud resources, where each setting can have at most one parent setting value. Key attributes include `name`, `displayName`, `description`, `readOnly` status, `dataType`, and `defaultValue`. Settings can be managed using several methods: `deleteValue`, `getValue`, `list` available settings, `lookupEffectiveValue` to check effective setting, `search` for existing settings, and `updateValue`. Read only setting can be deleted with a specific parameter.\n"]]