Resource Settings v1 API - Class Setting (2.3.0)

public sealed class Setting : IMessage<Setting>, IEquatable<Setting>, IDeepCloneable<Setting>, IBufferMessage, IMessage

Reference documentation and code samples for the Resource Settings v1 API class Setting.

The schema for settings.

Inheritance

object > Setting

Implements

IMessage Setting, IEquatable Setting, IDeepCloneable Setting, IBufferMessage, IMessage

Inherited Members

object.GetHashCode()

object.GetType()

object.ToString()

Namespace

Google.Cloud.ResourceSettings.V1

Assembly

Google.Cloud.ResourceSettings.V1.dll

Constructors

Setting()

public Setting()

Setting(Setting)

public Setting(Setting other)

Parameter
Name	Description
`other`	`Setting`

Properties

EffectiveValue

public Value EffectiveValue { get; set; }

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):

the local setting value on the given resource: [Setting.local_value][google.cloud.resourcesettings.v1.Setting.local_value]
if one of the given resource's ancestors have a local setting value, the local value at the nearest such ancestor
the setting's default value: [SettingMetadata.default_value][google.cloud.resourcesettings.v1.SettingMetadata.default_value]
an empty value (defined as a Value with all fields unset)

The data type of [Value][google.cloud.resourcesettings.v1.Value] must always be consistent with the data type defined in [Setting.metadata][google.cloud.resourcesettings.v1.Setting.metadata].

Property Value
Type	Description
`Value`

Etag

public string Etag { get; set; }

A fingerprint used for optimistic concurrency. See [UpdateSetting][google.cloud.resourcesettings.v1.ResourceSettingsService.UpdateSetting] for more details.

Property Value
Type	Description
`string`

LocalValue

public Value LocalValue { get; set; }

The configured value of the setting at the given parent resource (ignoring the resource hierarchy). The data type of [Value][google.cloud.resourcesettings.v1.Value] must always be consistent with the data type defined in [Setting.metadata][google.cloud.resourcesettings.v1.Setting.metadata].

Property Value
Type	Description
`Value`

Metadata

public SettingMetadata Metadata { get; set; }

Output only. Metadata about a setting which is not editable by the end user.

Property Value
Type	Description
`SettingMetadata`

Name

public string Name { get; set; }

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"

Property Value
Type	Description
`string`

SettingName

public SettingName SettingName { get; set; }

SettingName-typed view over the Name resource name property.

Property Value
Type	Description
`SettingName`