Class Setting.Builder (1.28.0)

public static final class Setting.Builder extends GeneratedMessageV3.Builder<Setting.Builder> implements SettingOrBuilder

The schema for settings.

Protobuf type google.cloud.resourcesettings.v1.Setting

Implements

SettingOrBuilder

Static Methods

getDescriptor()

public static final Descriptors.Descriptor getDescriptor()
Returns
TypeDescription
Descriptor

Methods

addRepeatedField(Descriptors.FieldDescriptor field, Object value)

public Setting.Builder addRepeatedField(Descriptors.FieldDescriptor field, Object value)
Parameters
NameDescription
fieldFieldDescriptor
valueObject
Returns
TypeDescription
Setting.Builder
Overrides

build()

public Setting build()
Returns
TypeDescription
Setting

buildPartial()

public Setting buildPartial()
Returns
TypeDescription
Setting

clear()

public Setting.Builder clear()
Returns
TypeDescription
Setting.Builder
Overrides

clearEffectiveValue()

public Setting.Builder clearEffectiveValue()

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
TypeDescription
Setting.Builder

clearEtag()

public Setting.Builder clearEtag()

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

string etag = 10;

Returns
TypeDescription
Setting.Builder

This builder for chaining.

clearField(Descriptors.FieldDescriptor field)

public Setting.Builder clearField(Descriptors.FieldDescriptor field)
Parameter
NameDescription
fieldFieldDescriptor
Returns
TypeDescription
Setting.Builder
Overrides

clearLocalValue()

public Setting.Builder clearLocalValue()

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
TypeDescription
Setting.Builder

clearMetadata()

public Setting.Builder clearMetadata()

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
TypeDescription
Setting.Builder

clearName()

public Setting.Builder clearName()

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
TypeDescription
Setting.Builder

This builder for chaining.

clearOneof(Descriptors.OneofDescriptor oneof)

public Setting.Builder clearOneof(Descriptors.OneofDescriptor oneof)
Parameter
NameDescription
oneofOneofDescriptor
Returns
TypeDescription
Setting.Builder
Overrides

clone()

public Setting.Builder clone()
Returns
TypeDescription
Setting.Builder
Overrides

getDefaultInstanceForType()

public Setting getDefaultInstanceForType()
Returns
TypeDescription
Setting

getDescriptorForType()

public Descriptors.Descriptor getDescriptorForType()
Returns
TypeDescription
Descriptor
Overrides

getEffectiveValue()

public 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
TypeDescription
Value

The effectiveValue.

getEffectiveValueBuilder()

public Value.Builder getEffectiveValueBuilder()

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
TypeDescription
Value.Builder

getEffectiveValueOrBuilder()

public 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
TypeDescription
ValueOrBuilder

getEtag()

public String getEtag()

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

string etag = 10;

Returns
TypeDescription
String

The etag.

getEtagBytes()

public ByteString getEtagBytes()

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

string etag = 10;

Returns
TypeDescription
ByteString

The bytes for etag.

getLocalValue()

public 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
TypeDescription
Value

The localValue.

getLocalValueBuilder()

public Value.Builder getLocalValueBuilder()

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
TypeDescription
Value.Builder

getLocalValueOrBuilder()

public 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
TypeDescription
ValueOrBuilder

getMetadata()

public 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
TypeDescription
SettingMetadata

The metadata.

getMetadataBuilder()

public SettingMetadata.Builder getMetadataBuilder()

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
TypeDescription
SettingMetadata.Builder

getMetadataOrBuilder()

public 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
TypeDescription
SettingMetadataOrBuilder

getName()

public 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
TypeDescription
String

The name.

getNameBytes()

public 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
TypeDescription
ByteString

The bytes for name.

hasEffectiveValue()

public 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
TypeDescription
boolean

Whether the effectiveValue field is set.

hasLocalValue()

public 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
TypeDescription
boolean

Whether the localValue field is set.

hasMetadata()

public 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
TypeDescription
boolean

Whether the metadata field is set.

internalGetFieldAccessorTable()

protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Returns
TypeDescription
FieldAccessorTable
Overrides

isInitialized()

public final boolean isInitialized()
Returns
TypeDescription
boolean
Overrides

mergeEffectiveValue(Value value)

public Setting.Builder mergeEffectiveValue(Value 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.

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

Parameter
NameDescription
valueValue
Returns
TypeDescription
Setting.Builder

mergeFrom(Setting other)

public Setting.Builder mergeFrom(Setting other)
Parameter
NameDescription
otherSetting
Returns
TypeDescription
Setting.Builder

mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public Setting.Builder mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
inputCodedInputStream
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
Setting.Builder
Overrides
Exceptions
TypeDescription
IOException

mergeFrom(Message other)

public Setting.Builder mergeFrom(Message other)
Parameter
NameDescription
otherMessage
Returns
TypeDescription
Setting.Builder
Overrides

mergeLocalValue(Value value)

public Setting.Builder mergeLocalValue(Value 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.

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

Parameter
NameDescription
valueValue
Returns
TypeDescription
Setting.Builder

mergeMetadata(SettingMetadata value)

public Setting.Builder mergeMetadata(SettingMetadata value)

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];

Parameter
NameDescription
valueSettingMetadata
Returns
TypeDescription
Setting.Builder

mergeUnknownFields(UnknownFieldSet unknownFields)

public final Setting.Builder mergeUnknownFields(UnknownFieldSet unknownFields)
Parameter
NameDescription
unknownFieldsUnknownFieldSet
Returns
TypeDescription
Setting.Builder
Overrides

setEffectiveValue(Value value)

public Setting.Builder setEffectiveValue(Value 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.

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

Parameter
NameDescription
valueValue
Returns
TypeDescription
Setting.Builder

setEffectiveValue(Value.Builder builderForValue)

public Setting.Builder setEffectiveValue(Value.Builder builderForValue)

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];

Parameter
NameDescription
builderForValueValue.Builder
Returns
TypeDescription
Setting.Builder

setEtag(String value)

public Setting.Builder setEtag(String value)

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

string etag = 10;

Parameter
NameDescription
valueString

The etag to set.

Returns
TypeDescription
Setting.Builder

This builder for chaining.

setEtagBytes(ByteString value)

public Setting.Builder setEtagBytes(ByteString value)

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

string etag = 10;

Parameter
NameDescription
valueByteString

The bytes for etag to set.

Returns
TypeDescription
Setting.Builder

This builder for chaining.

setField(Descriptors.FieldDescriptor field, Object value)

public Setting.Builder setField(Descriptors.FieldDescriptor field, Object value)
Parameters
NameDescription
fieldFieldDescriptor
valueObject
Returns
TypeDescription
Setting.Builder
Overrides

setLocalValue(Value value)

public Setting.Builder setLocalValue(Value 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.

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

Parameter
NameDescription
valueValue
Returns
TypeDescription
Setting.Builder

setLocalValue(Value.Builder builderForValue)

public Setting.Builder setLocalValue(Value.Builder builderForValue)

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;

Parameter
NameDescription
builderForValueValue.Builder
Returns
TypeDescription
Setting.Builder

setMetadata(SettingMetadata value)

public Setting.Builder setMetadata(SettingMetadata value)

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];

Parameter
NameDescription
valueSettingMetadata
Returns
TypeDescription
Setting.Builder

setMetadata(SettingMetadata.Builder builderForValue)

public Setting.Builder setMetadata(SettingMetadata.Builder builderForValue)

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];

Parameter
NameDescription
builderForValueSettingMetadata.Builder
Returns
TypeDescription
Setting.Builder

setName(String value)

public Setting.Builder setName(String value)

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;

Parameter
NameDescription
valueString

The name to set.

Returns
TypeDescription
Setting.Builder

This builder for chaining.

setNameBytes(ByteString value)

public Setting.Builder setNameBytes(ByteString value)

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;

Parameter
NameDescription
valueByteString

The bytes for name to set.

Returns
TypeDescription
Setting.Builder

This builder for chaining.

setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)

public Setting.Builder setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)
Parameters
NameDescription
fieldFieldDescriptor
indexint
valueObject
Returns
TypeDescription
Setting.Builder
Overrides

setUnknownFields(UnknownFieldSet unknownFields)

public final Setting.Builder setUnknownFields(UnknownFieldSet unknownFields)
Parameter
NameDescription
unknownFieldsUnknownFieldSet
Returns
TypeDescription
Setting.Builder
Overrides