public final class Setting extends GeneratedMessageV3 implements SettingOrBuilder
The schema for settings.
Protobuf type google.cloud.resourcesettings.v1.Setting
Inherited Members
com.google.protobuf.GeneratedMessageV3.<ListT>makeMutableCopy(ListT)
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 | |
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()
getDescriptor()
public static final Descriptors.Descriptor getDescriptor()
newBuilder()
public static Setting.Builder newBuilder()
newBuilder(Setting prototype)
public static Setting.Builder newBuilder(Setting prototype)
| Parameter |
|---|
| Name | Description |
prototype | Setting
|
public static Setting parseDelimitedFrom(InputStream input)
public static Setting parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
parseFrom(byte[] data)
public static Setting parseFrom(byte[] data)
| Parameter |
|---|
| Name | Description |
data | byte[]
|
parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
public static Setting parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
parseFrom(ByteString data)
public static Setting parseFrom(ByteString data)
parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
public static Setting parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
public static Setting parseFrom(CodedInputStream input)
public static Setting parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
public static Setting parseFrom(InputStream input)
public static Setting parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
parseFrom(ByteBuffer data)
public static Setting parseFrom(ByteBuffer data)
parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
public static Setting parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
parser()
public static Parser<Setting> parser()
Methods
equals(Object obj)
public boolean equals(Object obj)
| Parameter |
|---|
| Name | Description |
obj | Object
|
Overrides
getDefaultInstanceForType()
public Setting getDefaultInstanceForType()
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):
- the local setting value on the given resource: 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
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):
- the local setting value on the given resource: 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
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];
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;
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];
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];
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()
Overrides
getSerializedSize()
public int getSerializedSize()
| Returns |
|---|
| Type | Description |
int | |
Overrides
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):
- the local setting value on the given resource: 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
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.
|
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()
| Returns |
|---|
| Type | Description |
int | |
Overrides
internalGetFieldAccessorTable()
protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Overrides
isInitialized()
public final boolean isInitialized()
Overrides
newBuilderForType()
public Setting.Builder newBuilderForType()
newBuilderForType(GeneratedMessageV3.BuilderParent parent)
protected Setting.Builder newBuilderForType(GeneratedMessageV3.BuilderParent parent)
Overrides
newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
protected Object newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
Overrides
toBuilder()
public Setting.Builder toBuilder()
writeTo(CodedOutputStream output)
public void writeTo(CodedOutputStream output)
Overrides
