Resource Settings API . projects . settings

close()

Close httplib2 connections.

get(name, view=None, x__xgafv=None)

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

Args:
  name: string, Required. The name of the setting to get. See Setting for naming requirements. (required)
  view: string, The SettingView for this request.
    Allowed values
      SETTING_VIEW_UNSPECIFIED - The default / unset value. The API will default to the SETTING_VIEW_BASIC view.
      SETTING_VIEW_BASIC - Include Setting.metadata, but nothing else. This is the default value (for both ListSettings and GetSetting).
      SETTING_VIEW_EFFECTIVE_VALUE - Include Setting.effective_value, but nothing else.
      SETTING_VIEW_LOCAL_VALUE - Include Setting.local_value, but nothing else.
  x__xgafv: string, V1 error format.
    Allowed values
      1 - v1 error format
      2 - v2 error format

Returns:
  An object of the form:

    { # The schema for settings.
  "effectiveValue": { # The data in a setting value. # Output only. The effective value of the setting at the given parent resource, evaluated based on the resource hierarchy The effective value evaluates to one of the following options, in this order. If an option is not valid or doesn't exist, then the next option is used: 1. The local setting value on the given resource: Setting.local_value 2. If one of the given resource's ancestors in the resource hierarchy have a local setting value, the local value at the nearest such ancestor. 3. The setting's default value: SettingMetadata.default_value 4. An empty value, defined as a `Value` with all fields unset. The data type of Value must always be consistent with the data type defined in Setting.metadata.
    "booleanValue": True or False, # Defines this value as being a boolean value.
    "durationValue": "A String", # Defines this value as being a Duration.
    "enumValue": { # A enum value that can hold any enum type setting values. Each enum type is represented by a number, this representation is stored in the definitions. # Defines this value as being a Enum.
      "value": "A String", # The value of this enum
    },
    "stringMapValue": { # A string->string map value that can hold a map of string keys to string values. The maximum length of each string is 200 characters and there can be a maximum of 50 key-value pairs in the map. # Defines this value as being a StringMap.
      "mappings": { # The key-value pairs in the map
        "a_key": "A String",
      },
    },
    "stringSetValue": { # A string set value that can hold a set of strings. The maximum length of each string is 200 characters and there can be a maximum of 50 strings in the string set. # Defines this value as being a StringSet.
      "values": [ # The strings in the set
        "A String",
      ],
    },
    "stringValue": "A String", # Defines this value as being a string value.
  },
  "etag": "A String", # A fingerprint used for optimistic concurrency. See UpdateSetting for more details.
  "localValue": { # The data in a setting value. # The configured value of the setting at the given parent resource, ignoring the resource hierarchy. The data type of Value must always be consistent with the data type defined in Setting.metadata.
    "booleanValue": True or False, # Defines this value as being a boolean value.
    "durationValue": "A String", # Defines this value as being a Duration.
    "enumValue": { # A enum value that can hold any enum type setting values. Each enum type is represented by a number, this representation is stored in the definitions. # Defines this value as being a Enum.
      "value": "A String", # The value of this enum
    },
    "stringMapValue": { # A string->string map value that can hold a map of string keys to string values. The maximum length of each string is 200 characters and there can be a maximum of 50 key-value pairs in the map. # Defines this value as being a StringMap.
      "mappings": { # The key-value pairs in the map
        "a_key": "A String",
      },
    },
    "stringSetValue": { # A string set value that can hold a set of strings. The maximum length of each string is 200 characters and there can be a maximum of 50 strings in the string set. # Defines this value as being a StringSet.
      "values": [ # The strings in the set
        "A String",
      ],
    },
    "stringValue": "A String", # Defines this value as being a string value.
  },
  "metadata": { # Metadata about a setting which is not editable by the end user. # Output only. Metadata about a setting which is not editable by the end user.
    "dataType": "A String", # The data type for this setting.
    "defaultValue": { # The data in a setting value. # The value provided by Setting.effective_value if no setting value is explicitly set. Note: not all settings have a default value.
      "booleanValue": True or False, # Defines this value as being a boolean value.
      "durationValue": "A String", # Defines this value as being a Duration.
      "enumValue": { # A enum value that can hold any enum type setting values. Each enum type is represented by a number, this representation is stored in the definitions. # Defines this value as being a Enum.
        "value": "A String", # The value of this enum
      },
      "stringMapValue": { # A string->string map value that can hold a map of string keys to string values. The maximum length of each string is 200 characters and there can be a maximum of 50 key-value pairs in the map. # Defines this value as being a StringMap.
        "mappings": { # The key-value pairs in the map
          "a_key": "A String",
        },
      },
      "stringSetValue": { # A string set value that can hold a set of strings. The maximum length of each string is 200 characters and there can be a maximum of 50 strings in the string set. # Defines this value as being a StringSet.
        "values": [ # The strings in the set
          "A String",
        ],
      },
      "stringValue": "A String", # Defines this value as being a string value.
    },
    "description": "A String", # A detailed description of what this setting does.
    "displayName": "A String", # The human readable name for this setting.
    "readOnly": True or False, # A flag indicating that values of this setting cannot be modified. See documentation for the specific setting for updates and reasons.
  },
  "name": "A 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"
}

list(parent, pageSize=None, pageToken=None, view=None, x__xgafv=None)

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

Args:
  parent: string, 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)
  pageSize: integer, Unused. The size of the page to be returned.
  pageToken: string, Unused. A page token used to retrieve the next page.
  view: string, The SettingView for this request.
    Allowed values
      SETTING_VIEW_UNSPECIFIED - The default / unset value. The API will default to the SETTING_VIEW_BASIC view.
      SETTING_VIEW_BASIC - Include Setting.metadata, but nothing else. This is the default value (for both ListSettings and GetSetting).
      SETTING_VIEW_EFFECTIVE_VALUE - Include Setting.effective_value, but nothing else.
      SETTING_VIEW_LOCAL_VALUE - Include Setting.local_value, but nothing else.
  x__xgafv: string, V1 error format.
    Allowed values
      1 - v1 error format
      2 - v2 error format

Returns:
  An object of the form:

    { # The response from ListSettings.
  "nextPageToken": "A String", # Unused. A page token used to retrieve the next page.
  "settings": [ # A list of settings that are available at the specified Cloud resource.
    { # The schema for settings.
      "effectiveValue": { # The data in a setting value. # Output only. The effective value of the setting at the given parent resource, evaluated based on the resource hierarchy The effective value evaluates to one of the following options, in this order. If an option is not valid or doesn't exist, then the next option is used: 1. The local setting value on the given resource: Setting.local_value 2. If one of the given resource's ancestors in the resource hierarchy have a local setting value, the local value at the nearest such ancestor. 3. The setting's default value: SettingMetadata.default_value 4. An empty value, defined as a `Value` with all fields unset. The data type of Value must always be consistent with the data type defined in Setting.metadata.
        "booleanValue": True or False, # Defines this value as being a boolean value.
        "durationValue": "A String", # Defines this value as being a Duration.
        "enumValue": { # A enum value that can hold any enum type setting values. Each enum type is represented by a number, this representation is stored in the definitions. # Defines this value as being a Enum.
          "value": "A String", # The value of this enum
        },
        "stringMapValue": { # A string->string map value that can hold a map of string keys to string values. The maximum length of each string is 200 characters and there can be a maximum of 50 key-value pairs in the map. # Defines this value as being a StringMap.
          "mappings": { # The key-value pairs in the map
            "a_key": "A String",
          },
        },
        "stringSetValue": { # A string set value that can hold a set of strings. The maximum length of each string is 200 characters and there can be a maximum of 50 strings in the string set. # Defines this value as being a StringSet.
          "values": [ # The strings in the set
            "A String",
          ],
        },
        "stringValue": "A String", # Defines this value as being a string value.
      },
      "etag": "A String", # A fingerprint used for optimistic concurrency. See UpdateSetting for more details.
      "localValue": { # The data in a setting value. # The configured value of the setting at the given parent resource, ignoring the resource hierarchy. The data type of Value must always be consistent with the data type defined in Setting.metadata.
        "booleanValue": True or False, # Defines this value as being a boolean value.
        "durationValue": "A String", # Defines this value as being a Duration.
        "enumValue": { # A enum value that can hold any enum type setting values. Each enum type is represented by a number, this representation is stored in the definitions. # Defines this value as being a Enum.
          "value": "A String", # The value of this enum
        },
        "stringMapValue": { # A string->string map value that can hold a map of string keys to string values. The maximum length of each string is 200 characters and there can be a maximum of 50 key-value pairs in the map. # Defines this value as being a StringMap.
          "mappings": { # The key-value pairs in the map
            "a_key": "A String",
          },
        },
        "stringSetValue": { # A string set value that can hold a set of strings. The maximum length of each string is 200 characters and there can be a maximum of 50 strings in the string set. # Defines this value as being a StringSet.
          "values": [ # The strings in the set
            "A String",
          ],
        },
        "stringValue": "A String", # Defines this value as being a string value.
      },
      "metadata": { # Metadata about a setting which is not editable by the end user. # Output only. Metadata about a setting which is not editable by the end user.
        "dataType": "A String", # The data type for this setting.
        "defaultValue": { # The data in a setting value. # The value provided by Setting.effective_value if no setting value is explicitly set. Note: not all settings have a default value.
          "booleanValue": True or False, # Defines this value as being a boolean value.
          "durationValue": "A String", # Defines this value as being a Duration.
          "enumValue": { # A enum value that can hold any enum type setting values. Each enum type is represented by a number, this representation is stored in the definitions. # Defines this value as being a Enum.
            "value": "A String", # The value of this enum
          },
          "stringMapValue": { # A string->string map value that can hold a map of string keys to string values. The maximum length of each string is 200 characters and there can be a maximum of 50 key-value pairs in the map. # Defines this value as being a StringMap.
            "mappings": { # The key-value pairs in the map
              "a_key": "A String",
            },
          },
          "stringSetValue": { # A string set value that can hold a set of strings. The maximum length of each string is 200 characters and there can be a maximum of 50 strings in the string set. # Defines this value as being a StringSet.
            "values": [ # The strings in the set
              "A String",
            ],
          },
          "stringValue": "A String", # Defines this value as being a string value.
        },
        "description": "A String", # A detailed description of what this setting does.
        "displayName": "A String", # The human readable name for this setting.
        "readOnly": True or False, # A flag indicating that values of this setting cannot be modified. See documentation for the specific setting for updates and reasons.
      },
      "name": "A 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"
    },
  ],
}

list_next()

Retrieves the next page of results.

        Args:
          previous_request: The request for the previous page. (required)
          previous_response: The response from the request for the previous page. (required)

        Returns:
          A request object that you can call 'execute()' on to request the next
          page. Returns None if there are no more items in the collection.
        

patch(name, body=None, x__xgafv=None)

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.

Args:
  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" (required)
  body: object, The request body.
    The object takes the form of:

{ # The schema for settings.
  "effectiveValue": { # The data in a setting value. # Output only. The effective value of the setting at the given parent resource, evaluated based on the resource hierarchy The effective value evaluates to one of the following options, in this order. If an option is not valid or doesn't exist, then the next option is used: 1. The local setting value on the given resource: Setting.local_value 2. If one of the given resource's ancestors in the resource hierarchy have a local setting value, the local value at the nearest such ancestor. 3. The setting's default value: SettingMetadata.default_value 4. An empty value, defined as a `Value` with all fields unset. The data type of Value must always be consistent with the data type defined in Setting.metadata.
    "booleanValue": True or False, # Defines this value as being a boolean value.
    "durationValue": "A String", # Defines this value as being a Duration.
    "enumValue": { # A enum value that can hold any enum type setting values. Each enum type is represented by a number, this representation is stored in the definitions. # Defines this value as being a Enum.
      "value": "A String", # The value of this enum
    },
    "stringMapValue": { # A string->string map value that can hold a map of string keys to string values. The maximum length of each string is 200 characters and there can be a maximum of 50 key-value pairs in the map. # Defines this value as being a StringMap.
      "mappings": { # The key-value pairs in the map
        "a_key": "A String",
      },
    },
    "stringSetValue": { # A string set value that can hold a set of strings. The maximum length of each string is 200 characters and there can be a maximum of 50 strings in the string set. # Defines this value as being a StringSet.
      "values": [ # The strings in the set
        "A String",
      ],
    },
    "stringValue": "A String", # Defines this value as being a string value.
  },
  "etag": "A String", # A fingerprint used for optimistic concurrency. See UpdateSetting for more details.
  "localValue": { # The data in a setting value. # The configured value of the setting at the given parent resource, ignoring the resource hierarchy. The data type of Value must always be consistent with the data type defined in Setting.metadata.
    "booleanValue": True or False, # Defines this value as being a boolean value.
    "durationValue": "A String", # Defines this value as being a Duration.
    "enumValue": { # A enum value that can hold any enum type setting values. Each enum type is represented by a number, this representation is stored in the definitions. # Defines this value as being a Enum.
      "value": "A String", # The value of this enum
    },
    "stringMapValue": { # A string->string map value that can hold a map of string keys to string values. The maximum length of each string is 200 characters and there can be a maximum of 50 key-value pairs in the map. # Defines this value as being a StringMap.
      "mappings": { # The key-value pairs in the map
        "a_key": "A String",
      },
    },
    "stringSetValue": { # A string set value that can hold a set of strings. The maximum length of each string is 200 characters and there can be a maximum of 50 strings in the string set. # Defines this value as being a StringSet.
      "values": [ # The strings in the set
        "A String",
      ],
    },
    "stringValue": "A String", # Defines this value as being a string value.
  },
  "metadata": { # Metadata about a setting which is not editable by the end user. # Output only. Metadata about a setting which is not editable by the end user.
    "dataType": "A String", # The data type for this setting.
    "defaultValue": { # The data in a setting value. # The value provided by Setting.effective_value if no setting value is explicitly set. Note: not all settings have a default value.
      "booleanValue": True or False, # Defines this value as being a boolean value.
      "durationValue": "A String", # Defines this value as being a Duration.
      "enumValue": { # A enum value that can hold any enum type setting values. Each enum type is represented by a number, this representation is stored in the definitions. # Defines this value as being a Enum.
        "value": "A String", # The value of this enum
      },
      "stringMapValue": { # A string->string map value that can hold a map of string keys to string values. The maximum length of each string is 200 characters and there can be a maximum of 50 key-value pairs in the map. # Defines this value as being a StringMap.
        "mappings": { # The key-value pairs in the map
          "a_key": "A String",
        },
      },
      "stringSetValue": { # A string set value that can hold a set of strings. The maximum length of each string is 200 characters and there can be a maximum of 50 strings in the string set. # Defines this value as being a StringSet.
        "values": [ # The strings in the set
          "A String",
        ],
      },
      "stringValue": "A String", # Defines this value as being a string value.
    },
    "description": "A String", # A detailed description of what this setting does.
    "displayName": "A String", # The human readable name for this setting.
    "readOnly": True or False, # A flag indicating that values of this setting cannot be modified. See documentation for the specific setting for updates and reasons.
  },
  "name": "A 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"
}

  x__xgafv: string, V1 error format.
    Allowed values
      1 - v1 error format
      2 - v2 error format

Returns:
  An object of the form:

    { # The schema for settings.
  "effectiveValue": { # The data in a setting value. # Output only. The effective value of the setting at the given parent resource, evaluated based on the resource hierarchy The effective value evaluates to one of the following options, in this order. If an option is not valid or doesn't exist, then the next option is used: 1. The local setting value on the given resource: Setting.local_value 2. If one of the given resource's ancestors in the resource hierarchy have a local setting value, the local value at the nearest such ancestor. 3. The setting's default value: SettingMetadata.default_value 4. An empty value, defined as a `Value` with all fields unset. The data type of Value must always be consistent with the data type defined in Setting.metadata.
    "booleanValue": True or False, # Defines this value as being a boolean value.
    "durationValue": "A String", # Defines this value as being a Duration.
    "enumValue": { # A enum value that can hold any enum type setting values. Each enum type is represented by a number, this representation is stored in the definitions. # Defines this value as being a Enum.
      "value": "A String", # The value of this enum
    },
    "stringMapValue": { # A string->string map value that can hold a map of string keys to string values. The maximum length of each string is 200 characters and there can be a maximum of 50 key-value pairs in the map. # Defines this value as being a StringMap.
      "mappings": { # The key-value pairs in the map
        "a_key": "A String",
      },
    },
    "stringSetValue": { # A string set value that can hold a set of strings. The maximum length of each string is 200 characters and there can be a maximum of 50 strings in the string set. # Defines this value as being a StringSet.
      "values": [ # The strings in the set
        "A String",
      ],
    },
    "stringValue": "A String", # Defines this value as being a string value.
  },
  "etag": "A String", # A fingerprint used for optimistic concurrency. See UpdateSetting for more details.
  "localValue": { # The data in a setting value. # The configured value of the setting at the given parent resource, ignoring the resource hierarchy. The data type of Value must always be consistent with the data type defined in Setting.metadata.
    "booleanValue": True or False, # Defines this value as being a boolean value.
    "durationValue": "A String", # Defines this value as being a Duration.
    "enumValue": { # A enum value that can hold any enum type setting values. Each enum type is represented by a number, this representation is stored in the definitions. # Defines this value as being a Enum.
      "value": "A String", # The value of this enum
    },
    "stringMapValue": { # A string->string map value that can hold a map of string keys to string values. The maximum length of each string is 200 characters and there can be a maximum of 50 key-value pairs in the map. # Defines this value as being a StringMap.
      "mappings": { # The key-value pairs in the map
        "a_key": "A String",
      },
    },
    "stringSetValue": { # A string set value that can hold a set of strings. The maximum length of each string is 200 characters and there can be a maximum of 50 strings in the string set. # Defines this value as being a StringSet.
      "values": [ # The strings in the set
        "A String",
      ],
    },
    "stringValue": "A String", # Defines this value as being a string value.
  },
  "metadata": { # Metadata about a setting which is not editable by the end user. # Output only. Metadata about a setting which is not editable by the end user.
    "dataType": "A String", # The data type for this setting.
    "defaultValue": { # The data in a setting value. # The value provided by Setting.effective_value if no setting value is explicitly set. Note: not all settings have a default value.
      "booleanValue": True or False, # Defines this value as being a boolean value.
      "durationValue": "A String", # Defines this value as being a Duration.
      "enumValue": { # A enum value that can hold any enum type setting values. Each enum type is represented by a number, this representation is stored in the definitions. # Defines this value as being a Enum.
        "value": "A String", # The value of this enum
      },
      "stringMapValue": { # A string->string map value that can hold a map of string keys to string values. The maximum length of each string is 200 characters and there can be a maximum of 50 key-value pairs in the map. # Defines this value as being a StringMap.
        "mappings": { # The key-value pairs in the map
          "a_key": "A String",
        },
      },
      "stringSetValue": { # A string set value that can hold a set of strings. The maximum length of each string is 200 characters and there can be a maximum of 50 strings in the string set. # Defines this value as being a StringSet.
        "values": [ # The strings in the set
          "A String",
        ],
      },
      "stringValue": "A String", # Defines this value as being a string value.
    },
    "description": "A String", # A detailed description of what this setting does.
    "displayName": "A String", # The human readable name for this setting.
    "readOnly": True or False, # A flag indicating that values of this setting cannot be modified. See documentation for the specific setting for updates and reasons.
  },
  "name": "A 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"
}