Class Setting (1.3.1)

Version 1.3.1

• 1.57.0 (latest)
• 1.56.0
• 1.55.0
• 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 final class Setting extends GeneratedMessageV3 implements SettingOrBuilder

The schema for settings.

Protobuf type google.cloud.resourcesettings.v1.Setting

Inheritance

Object > AbstractMessageLite<MessageType,BuilderType> > AbstractMessage > GeneratedMessageV3 > Setting

Implements

SettingOrBuilder

Inherited Members

AbstractMessage.equals(Object)

AbstractMessage.findInitializationErrors()

AbstractMessage.getInitializationErrorString()

AbstractMessage.hashBoolean(boolean)

AbstractMessage.hashCode()

AbstractMessage.hashEnum(Internal.EnumLite)

AbstractMessage.hashEnumList(List<? extends Internal.EnumLite>)

AbstractMessage.hashFields(int,Map<Descriptors.FieldDescriptor,Object>)

AbstractMessage.hashLong(long)

AbstractMessage.toString()

AbstractMessageLite.<T>addAll(Iterable<T>,Collection<? super T>)

AbstractMessageLite.<T>addAll(Iterable<T>,List<? super T>)

AbstractMessageLite.checkByteStringIsUtf8(ByteString)

AbstractMessageLite.toByteArray()

AbstractMessageLite.toByteString()

AbstractMessageLite.writeDelimitedTo(OutputStream)

AbstractMessageLite.writeTo(OutputStream)

GeneratedMessageV3.<M>parseDelimitedWithIOException(Parser<M>,InputStream)

GeneratedMessageV3.<M>parseDelimitedWithIOException(Parser<M>,InputStream,ExtensionRegistryLite)

GeneratedMessageV3.<M>parseWithIOException(Parser<M>,CodedInputStream)

GeneratedMessageV3.<M>parseWithIOException(Parser<M>,CodedInputStream,ExtensionRegistryLite)

GeneratedMessageV3.<M>parseWithIOException(Parser<M>,InputStream)

GeneratedMessageV3.<M>parseWithIOException(Parser<M>,InputStream,ExtensionRegistryLite)

GeneratedMessageV3.<V>serializeBooleanMapTo(CodedOutputStream,MapField<Boolean,V>,MapEntry<Boolean,V>,int)

GeneratedMessageV3.<V>serializeIntegerMapTo(CodedOutputStream,MapField<Integer,V>,MapEntry<Integer,V>,int)

GeneratedMessageV3.<V>serializeLongMapTo(CodedOutputStream,MapField<Long,V>,MapEntry<Long,V>,int)

GeneratedMessageV3.<V>serializeStringMapTo(CodedOutputStream,MapField<String,V>,MapEntry<String,V>,int)

GeneratedMessageV3.canUseUnsafe()

GeneratedMessageV3.computeStringSize(int,Object)

GeneratedMessageV3.computeStringSizeNoTag(Object)

GeneratedMessageV3.emptyBooleanList()

GeneratedMessageV3.emptyDoubleList()

GeneratedMessageV3.emptyFloatList()

GeneratedMessageV3.emptyIntList()

GeneratedMessageV3.emptyLongList()

GeneratedMessageV3.getAllFields()

GeneratedMessageV3.getDescriptorForType()

GeneratedMessageV3.getField(Descriptors.FieldDescriptor)

GeneratedMessageV3.getOneofFieldDescriptor(Descriptors.OneofDescriptor)

GeneratedMessageV3.getParserForType()

GeneratedMessageV3.getRepeatedField(Descriptors.FieldDescriptor,int)

GeneratedMessageV3.getRepeatedFieldCount(Descriptors.FieldDescriptor)

GeneratedMessageV3.getSerializedSize()

GeneratedMessageV3.getUnknownFields()

GeneratedMessageV3.hasField(Descriptors.FieldDescriptor)

GeneratedMessageV3.hasOneof(Descriptors.OneofDescriptor)

GeneratedMessageV3.internalGetFieldAccessorTable()

GeneratedMessageV3.internalGetMapField(int)

GeneratedMessageV3.isInitialized()

GeneratedMessageV3.isStringEmpty(Object)

GeneratedMessageV3.makeExtensionsImmutable()

GeneratedMessageV3.mergeFromAndMakeImmutableInternal(CodedInputStream,ExtensionRegistryLite)

GeneratedMessageV3.mutableCopy(Internal.BooleanList)

GeneratedMessageV3.mutableCopy(Internal.DoubleList)

GeneratedMessageV3.mutableCopy(Internal.FloatList)

GeneratedMessageV3.mutableCopy(Internal.IntList)

GeneratedMessageV3.mutableCopy(Internal.LongList)

GeneratedMessageV3.newBooleanList()

GeneratedMessageV3.newBuilderForType(AbstractMessage.BuilderParent)

GeneratedMessageV3.newBuilderForType(GeneratedMessageV3.BuilderParent)

GeneratedMessageV3.newDoubleList()

GeneratedMessageV3.newFloatList()

GeneratedMessageV3.newInstance(GeneratedMessageV3.UnusedPrivateParameter)

GeneratedMessageV3.newIntList()

GeneratedMessageV3.newLongList()

GeneratedMessageV3.parseUnknownField(CodedInputStream,UnknownFieldSet.Builder,ExtensionRegistryLite,int)

GeneratedMessageV3.parseUnknownFieldProto3(CodedInputStream,UnknownFieldSet.Builder,ExtensionRegistryLite,int)

GeneratedMessageV3.writeReplace()

GeneratedMessageV3.writeString(CodedOutputStream,int,Object)

GeneratedMessageV3.writeStringNoTag(CodedOutputStream,Object)

GeneratedMessageV3.writeTo(CodedOutputStream)

Object.clone()

Object.finalize()

Object.getClass()

Object.notify()

Object.notifyAll()

Object.wait()

Object.wait(long)

Object.wait(long,int)

Static Fields

EFFECTIVE_VALUE_FIELD_NUMBER

public static final int EFFECTIVE_VALUE_FIELD_NUMBER

Field Value

Type	Description
int

ETAG_FIELD_NUMBER

public static final int ETAG_FIELD_NUMBER

Field Value

Type	Description
int

LOCAL_VALUE_FIELD_NUMBER

public static final int LOCAL_VALUE_FIELD_NUMBER

Field Value

Type	Description
int

METADATA_FIELD_NUMBER

public static final int METADATA_FIELD_NUMBER

Field Value

Type	Description
int

NAME_FIELD_NUMBER

public static final int NAME_FIELD_NUMBER

Field Value

Type	Description
int

Static Methods

getDefaultInstance()

public static Setting getDefaultInstance()

Returns

Type	Description
Setting

getDescriptor()

public static final Descriptors.Descriptor getDescriptor()

Returns

Type	Description
Descriptor

newBuilder()

public static Setting.Builder newBuilder()

Returns

Type	Description
Setting.Builder

newBuilder(Setting prototype)

public static Setting.Builder newBuilder(Setting prototype)

Parameter

Name	Description
prototype	Setting

Returns

Type	Description
Setting.Builder

parseDelimitedFrom(InputStream input)

public static Setting parseDelimitedFrom(InputStream input)

Parameter

Name	Description
input	InputStream

Returns

Type	Description
Setting

Exceptions

Type	Description
IOException

parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static Setting parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

Parameters

Name	Description
input	InputStream
extensionRegistry	ExtensionRegistryLite

Returns

Type	Description
Setting

Exceptions

Type	Description
IOException

parseFrom(byte[] data)

public static Setting parseFrom(byte[] data)

Parameter

Name	Description
data	byte[]

Returns

Type	Description
Setting

Exceptions

Type	Description
InvalidProtocolBufferException

parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)

public static Setting parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)

Parameters

Name	Description
data	byte[]
extensionRegistry	ExtensionRegistryLite

Returns

Type	Description
Setting

Exceptions

Type	Description
InvalidProtocolBufferException

parseFrom(ByteString data)

public static Setting parseFrom(ByteString data)

Parameter

Name	Description
data	ByteString

Returns

Type	Description
Setting

Exceptions

Type	Description
InvalidProtocolBufferException

parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)

public static Setting parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)

Parameters

Name	Description
data	ByteString
extensionRegistry	ExtensionRegistryLite

Returns

Type	Description
Setting

Exceptions

Type	Description
InvalidProtocolBufferException

parseFrom(CodedInputStream input)

public static Setting parseFrom(CodedInputStream input)

Parameter

Name	Description
input	CodedInputStream

Returns

Type	Description
Setting

Exceptions

Type	Description
IOException

parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public static Setting parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

Parameters

Name	Description
input	CodedInputStream
extensionRegistry	ExtensionRegistryLite

Returns

Type	Description
Setting

Exceptions

Type	Description
IOException

parseFrom(InputStream input)

public static Setting parseFrom(InputStream input)

Parameter

Name	Description
input	InputStream

Returns

Type	Description
Setting

Exceptions

Type	Description
IOException

parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static Setting parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

Parameters

Name	Description
input	InputStream
extensionRegistry	ExtensionRegistryLite

Returns

Type	Description
Setting

Exceptions

Type	Description
IOException

parseFrom(ByteBuffer data)

public static Setting parseFrom(ByteBuffer data)

Parameter

Name	Description
data	ByteBuffer

Returns

Type	Description
Setting

Exceptions

Type	Description
InvalidProtocolBufferException

parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)

public static Setting parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)

Parameters

Name	Description
data	ByteBuffer
extensionRegistry	ExtensionRegistryLite

Returns

Type	Description
Setting

Exceptions

Type	Description
InvalidProtocolBufferException

parser()

public static Parser<Setting> parser()

Returns

Type	Description
Parser<Setting>

Methods

equals(Object obj)

public boolean equals(Object obj)

Parameter

Name	Description
obj	Object

Returns

Type	Description
boolean

Overrides

AbstractMessage.equals(Object other)

getDefaultInstanceForType()

public Setting getDefaultInstanceForType()

Returns

Type	Description
Setting

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

Type	Description
Value	The effectiveValue.

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

Type	Description
ValueOrBuilder

getEtag()

public String getEtag()

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

string etag = 10;

Returns

Type	Description
String	The etag.

getEtagBytes()

public 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 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 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 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 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 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 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.

getParserForType()

public Parser<Setting> getParserForType()

Returns

Type	Description
Parser<Setting>

Overrides

GeneratedMessageV3.getParserForType()

getSerializedSize()

public int getSerializedSize()

Returns

Type	Description
int

Overrides

GeneratedMessageV3.getSerializedSize()

getUnknownFields()

public final UnknownFieldSet getUnknownFields()

Returns

Type	Description
UnknownFieldSet

Overrides

GeneratedMessageV3.getUnknownFields()

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

Type	Description
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

Type	Description
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

Type	Description
boolean	Whether the metadata field is set.

hashCode()

public int hashCode()

Returns

Type	Description
int

Overrides

AbstractMessage.hashCode()

internalGetFieldAccessorTable()

protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()

Returns

Type	Description
FieldAccessorTable

Overrides

GeneratedMessageV3.internalGetFieldAccessorTable()

isInitialized()

public final boolean isInitialized()

Returns

Type	Description
boolean

Overrides

GeneratedMessageV3.isInitialized()

newBuilderForType()

public Setting.Builder newBuilderForType()

Returns

Type	Description
Setting.Builder

newBuilderForType(GeneratedMessageV3.BuilderParent parent)

protected Setting.Builder newBuilderForType(GeneratedMessageV3.BuilderParent parent)

Parameter

Name	Description
parent	BuilderParent

Returns

Type	Description
Setting.Builder

Overrides

GeneratedMessageV3.newBuilderForType(GeneratedMessageV3.BuilderParent parent)

newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)

protected Object newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)

Parameter

Name	Description
unused	UnusedPrivateParameter

Returns

Type	Description
Object

Overrides

GeneratedMessageV3.newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)

toBuilder()

public Setting.Builder toBuilder()

Returns

Type	Description
Setting.Builder

writeTo(CodedOutputStream output)

public void writeTo(CodedOutputStream output)

Parameter

Name	Description
output	CodedOutputStream

Overrides

GeneratedMessageV3.writeTo(CodedOutputStream output)

Exceptions

Type	Description
IOException