Interface SettingOrBuilder (1.54.0)

Version 1.54.0

• 1.55.0 (latest)
• 1.54.0
• 1.53.0
• 1.52.0
• 1.51.0
• 1.49.0
• 1.48.0
• 1.47.0
• 1.46.0
• 1.45.0
• 1.44.0
• 1.43.0
• 1.42.0
• 1.41.0
• 1.40.0
• 1.39.0
• 1.37.0
• 1.36.0
• 1.35.0
• 1.34.0
• 1.33.0
• 1.32.0
• 1.31.0
• 1.30.0
• 1.29.0
• 1.28.0
• 1.27.0
• 1.24.0
• 1.23.0
• 1.22.0
• 1.21.0
• 1.20.0
• 1.19.0
• 1.18.0
• 1.17.0
• 1.16.0
• 1.15.0
• 1.14.0
• 1.13.0
• 1.12.0
• 1.11.0
• 1.9.0
• 1.8.0
• 1.7.0
• 1.6.0
• 1.5.0
• 1.4.0
• 1.3.5
• 1.2.1
• 1.1.9

public interface SettingOrBuilder extends MessageOrBuilder

Implements

MessageOrBuilder

Methods

getEffectiveValue()

public abstract Value getEffectiveValue()

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.

.google.cloud.resourcesettings.v1.Value effective_value = 9 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type	Description
Value	The effectiveValue.

getEffectiveValueOrBuilder()

public abstract ValueOrBuilder getEffectiveValueOrBuilder()

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.

.google.cloud.resourcesettings.v1.Value effective_value = 9 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type	Description
ValueOrBuilder

getEtag()

public abstract String getEtag()

A fingerprint used for optimistic concurrency. See UpdateSetting for more details.

string etag = 10;

Returns
Type	Description
String	The etag.

getEtagBytes()

public abstract ByteString getEtagBytes()

A fingerprint used for optimistic concurrency. See UpdateSetting for more details.

string etag = 10;

Returns
Type	Description
ByteString	The bytes for etag.

getLocalValue()

public abstract Value getLocalValue()

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.

.google.cloud.resourcesettings.v1.Value local_value = 8;

Returns
Type	Description
Value	The localValue.

getLocalValueOrBuilder()

public abstract ValueOrBuilder getLocalValueOrBuilder()

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.

.google.cloud.resourcesettings.v1.Value local_value = 8;

Returns
Type	Description
ValueOrBuilder

getMetadata()

public abstract SettingMetadata getMetadata()

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

.google.cloud.resourcesettings.v1.SettingMetadata metadata = 7 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type	Description
SettingMetadata	The metadata.

getMetadataOrBuilder()

public abstract SettingMetadataOrBuilder getMetadataOrBuilder()

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

.google.cloud.resourcesettings.v1.SettingMetadata metadata = 7 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type	Description
SettingMetadataOrBuilder

getName()

public abstract String getName()

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"

string name = 1;

Returns
Type	Description
String	The name.

getNameBytes()

public abstract ByteString getNameBytes()

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"

string name = 1;

Returns
Type	Description
ByteString	The bytes for name.

hasEffectiveValue()

public abstract boolean hasEffectiveValue()

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.

.google.cloud.resourcesettings.v1.Value effective_value = 9 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type	Description
boolean	Whether the effectiveValue field is set.

hasLocalValue()

public abstract boolean hasLocalValue()

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.

.google.cloud.resourcesettings.v1.Value local_value = 8;

Returns
Type	Description
boolean	Whether the localValue field is set.

hasMetadata()

public abstract boolean hasMetadata()

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

.google.cloud.resourcesettings.v1.SettingMetadata metadata = 7 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type	Description
boolean	Whether the metadata field is set.