Resource Settings V1 API - Class Google::Cloud::ResourceSettings::V1::Setting (v0.6.0)

Version 0.6.0

• 1.1.0 (latest)
• 1.0.1
• 0.7.1
• 0.6.2
• 0.5.0
• 0.4.1
• 0.3.0
• 0.2.0
• 0.1.5

Reference documentation and code samples for the Resource Settings V1 API class Google::Cloud::ResourceSettings::V1::Setting.

The schema for settings.

Inherits

• Object

Extended By

• Google::Protobuf::MessageExts::ClassMethods

Includes

• Google::Protobuf::MessageExts

Methods

#effective_value

def effective_value() -> ::Google::Cloud::ResourceSettings::V1::Value

Returns

• (::Google::Cloud::ResourceSettings::V1::Value) — Output only. The computed effective value of the setting at the given parent resource (based on the resource hierarchy).

  The effective value evaluates to one of the following options in the given order (the next option is used if the previous one does not exist):

  1. the local setting value on the given resource: Setting.local_value
  2. if one of the given resource's ancestors 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.

#etag

def etag() -> ::String

Returns

• (::String) — A fingerprint used for optimistic concurrency. See UpdateSetting for more details.

#etag=

def etag=(value) -> ::String

Parameter

• value (::String) — A fingerprint used for optimistic concurrency. See UpdateSetting for more details.

Returns

• (::String) — A fingerprint used for optimistic concurrency. See UpdateSetting for more details.

#local_value

def local_value() -> ::Google::Cloud::ResourceSettings::V1::Value

Returns

• (::Google::Cloud::ResourceSettings::V1::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.

#local_value=

def local_value=(value) -> ::Google::Cloud::ResourceSettings::V1::Value

Parameter

• value (::Google::Cloud::ResourceSettings::V1::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.

Returns

• (::Google::Cloud::ResourceSettings::V1::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.

#metadata

def metadata() -> ::Google::Cloud::ResourceSettings::V1::SettingMetadata

Returns

• (::Google::Cloud::ResourceSettings::V1::SettingMetadata) — Output only. Metadata about a setting which is not editable by the end user.

#name

def name() -> ::String

Returns

• (::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"

#name=

def name=(value) -> ::String

Parameter

• value (::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"

Returns

• (::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"