Class SettingMetadata (1.44.0)

public final class SettingMetadata extends GeneratedMessageV3 implements SettingMetadataOrBuilder

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

Protobuf type google.cloud.resourcesettings.v1.SettingMetadata

Static Fields

DATA_TYPE_FIELD_NUMBER

public static final int DATA_TYPE_FIELD_NUMBER
Field Value
Type Description
int

DEFAULT_VALUE_FIELD_NUMBER

public static final int DEFAULT_VALUE_FIELD_NUMBER
Field Value
Type Description
int

DESCRIPTION_FIELD_NUMBER

public static final int DESCRIPTION_FIELD_NUMBER
Field Value
Type Description
int

DISPLAY_NAME_FIELD_NUMBER

public static final int DISPLAY_NAME_FIELD_NUMBER
Field Value
Type Description
int

READ_ONLY_FIELD_NUMBER

public static final int READ_ONLY_FIELD_NUMBER
Field Value
Type Description
int

Static Methods

getDefaultInstance()

public static SettingMetadata getDefaultInstance()
Returns
Type Description
SettingMetadata

getDescriptor()

public static final Descriptors.Descriptor getDescriptor()
Returns
Type Description
Descriptor

newBuilder()

public static SettingMetadata.Builder newBuilder()
Returns
Type Description
SettingMetadata.Builder

newBuilder(SettingMetadata prototype)

public static SettingMetadata.Builder newBuilder(SettingMetadata prototype)
Parameter
Name Description
prototype SettingMetadata
Returns
Type Description
SettingMetadata.Builder

parseDelimitedFrom(InputStream input)

public static SettingMetadata parseDelimitedFrom(InputStream input)
Parameter
Name Description
input InputStream
Returns
Type Description
SettingMetadata
Exceptions
Type Description
IOException

parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static SettingMetadata parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input InputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
SettingMetadata
Exceptions
Type Description
IOException

parseFrom(byte[] data)

public static SettingMetadata parseFrom(byte[] data)
Parameter
Name Description
data byte[]
Returns
Type Description
SettingMetadata
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)

public static SettingMetadata parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
data byte[]
extensionRegistry ExtensionRegistryLite
Returns
Type Description
SettingMetadata
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteString data)

public static SettingMetadata parseFrom(ByteString data)
Parameter
Name Description
data ByteString
Returns
Type Description
SettingMetadata
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)

public static SettingMetadata parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
data ByteString
extensionRegistry ExtensionRegistryLite
Returns
Type Description
SettingMetadata
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(CodedInputStream input)

public static SettingMetadata parseFrom(CodedInputStream input)
Parameter
Name Description
input CodedInputStream
Returns
Type Description
SettingMetadata
Exceptions
Type Description
IOException

parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public static SettingMetadata parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input CodedInputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
SettingMetadata
Exceptions
Type Description
IOException

parseFrom(InputStream input)

public static SettingMetadata parseFrom(InputStream input)
Parameter
Name Description
input InputStream
Returns
Type Description
SettingMetadata
Exceptions
Type Description
IOException

parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static SettingMetadata parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input InputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
SettingMetadata
Exceptions
Type Description
IOException

parseFrom(ByteBuffer data)

public static SettingMetadata parseFrom(ByteBuffer data)
Parameter
Name Description
data ByteBuffer
Returns
Type Description
SettingMetadata
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)

public static SettingMetadata parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
data ByteBuffer
extensionRegistry ExtensionRegistryLite
Returns
Type Description
SettingMetadata
Exceptions
Type Description
InvalidProtocolBufferException

parser()

public static Parser<SettingMetadata> parser()
Returns
Type Description
Parser<SettingMetadata>

Methods

equals(Object obj)

public boolean equals(Object obj)
Parameter
Name Description
obj Object
Returns
Type Description
boolean
Overrides

getDataType()

public SettingMetadata.DataType getDataType()

The data type for this setting.

.google.cloud.resourcesettings.v1.SettingMetadata.DataType data_type = 4;

Returns
Type Description
SettingMetadata.DataType

The dataType.

getDataTypeValue()

public int getDataTypeValue()

The data type for this setting.

.google.cloud.resourcesettings.v1.SettingMetadata.DataType data_type = 4;

Returns
Type Description
int

The enum numeric value on the wire for dataType.

getDefaultInstanceForType()

public SettingMetadata getDefaultInstanceForType()
Returns
Type Description
SettingMetadata

getDefaultValue()

public Value getDefaultValue()

The value provided by Setting.effective_value if no setting value is explicitly set.

Note: not all settings have a default value.

.google.cloud.resourcesettings.v1.Value default_value = 5;

Returns
Type Description
Value

The defaultValue.

getDefaultValueOrBuilder()

public ValueOrBuilder getDefaultValueOrBuilder()

The value provided by Setting.effective_value if no setting value is explicitly set.

Note: not all settings have a default value.

.google.cloud.resourcesettings.v1.Value default_value = 5;

Returns
Type Description
ValueOrBuilder

getDescription()

public String getDescription()

A detailed description of what this setting does.

string description = 2;

Returns
Type Description
String

The description.

getDescriptionBytes()

public ByteString getDescriptionBytes()

A detailed description of what this setting does.

string description = 2;

Returns
Type Description
ByteString

The bytes for description.

getDisplayName()

public String getDisplayName()

The human readable name for this setting.

string display_name = 1;

Returns
Type Description
String

The displayName.

getDisplayNameBytes()

public ByteString getDisplayNameBytes()

The human readable name for this setting.

string display_name = 1;

Returns
Type Description
ByteString

The bytes for displayName.

getParserForType()

public Parser<SettingMetadata> getParserForType()
Returns
Type Description
Parser<SettingMetadata>
Overrides

getReadOnly()

public boolean getReadOnly()

A flag indicating that values of this setting cannot be modified (see documentation of the specific setting for updates and reasons).

bool read_only = 3;

Returns
Type Description
boolean

The readOnly.

getSerializedSize()

public int getSerializedSize()
Returns
Type Description
int
Overrides

hasDefaultValue()

public boolean hasDefaultValue()

The value provided by Setting.effective_value if no setting value is explicitly set.

Note: not all settings have a default value.

.google.cloud.resourcesettings.v1.Value default_value = 5;

Returns
Type Description
boolean

Whether the defaultValue field is set.

hashCode()

public int hashCode()
Returns
Type Description
int
Overrides

internalGetFieldAccessorTable()

protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Returns
Type Description
FieldAccessorTable
Overrides

isInitialized()

public final boolean isInitialized()
Returns
Type Description
boolean
Overrides

newBuilderForType()

public SettingMetadata.Builder newBuilderForType()
Returns
Type Description
SettingMetadata.Builder

newBuilderForType(GeneratedMessageV3.BuilderParent parent)

protected SettingMetadata.Builder newBuilderForType(GeneratedMessageV3.BuilderParent parent)
Parameter
Name Description
parent BuilderParent
Returns
Type Description
SettingMetadata.Builder
Overrides

newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)

protected Object newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
Parameter
Name Description
unused UnusedPrivateParameter
Returns
Type Description
Object
Overrides

toBuilder()

public SettingMetadata.Builder toBuilder()
Returns
Type Description
SettingMetadata.Builder

writeTo(CodedOutputStream output)

public void writeTo(CodedOutputStream output)
Parameter
Name Description
output CodedOutputStream
Overrides
Exceptions
Type Description
IOException