Class Property (2.9.1)

public final class Property extends GeneratedMessageV3 implements PropertyOrBuilder

Defines project properties. API services can define properties that can be assigned to consumer projects so that backends can perform response customization without having to make additional calls or maintain additional storage. For example, Maps API defines properties that controls map tile cache period, or whether to embed a watermark in a result. These values can be set via API producer console. Only API providers can define and set these properties.

Protobuf type google.api.Property

Implements

PropertyOrBuilder

Static Fields

DESCRIPTION_FIELD_NUMBER

public static final int DESCRIPTION_FIELD_NUMBER
Field Value
TypeDescription
int

NAME_FIELD_NUMBER

public static final int NAME_FIELD_NUMBER
Field Value
TypeDescription
int

TYPE_FIELD_NUMBER

public static final int TYPE_FIELD_NUMBER
Field Value
TypeDescription
int

Static Methods

getDefaultInstance()

public static Property getDefaultInstance()
Returns
TypeDescription
Property

getDescriptor()

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

newBuilder()

public static Property.Builder newBuilder()
Returns
TypeDescription
Property.Builder

newBuilder(Property prototype)

public static Property.Builder newBuilder(Property prototype)
Parameter
NameDescription
prototypeProperty
Returns
TypeDescription
Property.Builder

parseDelimitedFrom(InputStream input)

public static Property parseDelimitedFrom(InputStream input)
Parameter
NameDescription
inputInputStream
Returns
TypeDescription
Property
Exceptions
TypeDescription
IOException

parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static Property parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
inputInputStream
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
Property
Exceptions
TypeDescription
IOException

parseFrom(byte[] data)

public static Property parseFrom(byte[] data)
Parameter
NameDescription
databyte[]
Returns
TypeDescription
Property
Exceptions
TypeDescription
InvalidProtocolBufferException

parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)

public static Property parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
databyte[]
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
Property
Exceptions
TypeDescription
InvalidProtocolBufferException

parseFrom(ByteString data)

public static Property parseFrom(ByteString data)
Parameter
NameDescription
dataByteString
Returns
TypeDescription
Property
Exceptions
TypeDescription
InvalidProtocolBufferException

parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)

public static Property parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
dataByteString
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
Property
Exceptions
TypeDescription
InvalidProtocolBufferException

parseFrom(CodedInputStream input)

public static Property parseFrom(CodedInputStream input)
Parameter
NameDescription
inputCodedInputStream
Returns
TypeDescription
Property
Exceptions
TypeDescription
IOException

parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public static Property parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
inputCodedInputStream
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
Property
Exceptions
TypeDescription
IOException

parseFrom(InputStream input)

public static Property parseFrom(InputStream input)
Parameter
NameDescription
inputInputStream
Returns
TypeDescription
Property
Exceptions
TypeDescription
IOException

parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static Property parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
inputInputStream
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
Property
Exceptions
TypeDescription
IOException

parseFrom(ByteBuffer data)

public static Property parseFrom(ByteBuffer data)
Parameter
NameDescription
dataByteBuffer
Returns
TypeDescription
Property
Exceptions
TypeDescription
InvalidProtocolBufferException

parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)

public static Property parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
dataByteBuffer
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
Property
Exceptions
TypeDescription
InvalidProtocolBufferException

parser()

public static Parser<Property> parser()
Returns
TypeDescription
Parser<Property>

Methods

equals(Object obj)

public boolean equals(Object obj)
Parameter
NameDescription
objObject
Returns
TypeDescription
boolean
Overrides

getDefaultInstanceForType()

public Property getDefaultInstanceForType()
Returns
TypeDescription
Property

getDescription()

public String getDescription()

The description of the property

string description = 3;

Returns
TypeDescription
String

The description.

getDescriptionBytes()

public ByteString getDescriptionBytes()

The description of the property

string description = 3;

Returns
TypeDescription
ByteString

The bytes for description.

getName()

public String getName()

The name of the property (a.k.a key).

string name = 1;

Returns
TypeDescription
String

The name.

getNameBytes()

public ByteString getNameBytes()

The name of the property (a.k.a key).

string name = 1;

Returns
TypeDescription
ByteString

The bytes for name.

getParserForType()

public Parser<Property> getParserForType()
Returns
TypeDescription
Parser<Property>
Overrides

getSerializedSize()

public int getSerializedSize()
Returns
TypeDescription
int
Overrides

getType()

public Property.PropertyType getType()

The type of this property.

.google.api.Property.PropertyType type = 2;

Returns
TypeDescription
Property.PropertyType

The type.

getTypeValue()

public int getTypeValue()

The type of this property.

.google.api.Property.PropertyType type = 2;

Returns
TypeDescription
int

The enum numeric value on the wire for type.

getUnknownFields()

public final UnknownFieldSet getUnknownFields()
Returns
TypeDescription
UnknownFieldSet
Overrides

hashCode()

public int hashCode()
Returns
TypeDescription
int
Overrides

internalGetFieldAccessorTable()

protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Returns
TypeDescription
FieldAccessorTable
Overrides

isInitialized()

public final boolean isInitialized()
Returns
TypeDescription
boolean
Overrides

newBuilderForType()

public Property.Builder newBuilderForType()
Returns
TypeDescription
Property.Builder

newBuilderForType(GeneratedMessageV3.BuilderParent parent)

protected Property.Builder newBuilderForType(GeneratedMessageV3.BuilderParent parent)
Parameter
NameDescription
parentBuilderParent
Returns
TypeDescription
Property.Builder
Overrides

newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)

protected Object newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
Parameter
NameDescription
unusedUnusedPrivateParameter
Returns
TypeDescription
Object
Overrides

toBuilder()

public Property.Builder toBuilder()
Returns
TypeDescription
Property.Builder

writeTo(CodedOutputStream output)

public void writeTo(CodedOutputStream output)
Parameter
NameDescription
outputCodedOutputStream
Overrides Exceptions
TypeDescription
IOException