Class Property.Builder (2.25.0)

public static final class Property.Builder extends GeneratedMessageV3.Builder<Property.Builder> 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 Methods

getDescriptor()

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

Methods

addRepeatedField(Descriptors.FieldDescriptor field, Object value)

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

build()

public Property build()
Returns
TypeDescription
Property

buildPartial()

public Property buildPartial()
Returns
TypeDescription
Property

clear()

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

clearDescription()

public Property.Builder clearDescription()

The description of the property

string description = 3;

Returns
TypeDescription
Property.Builder

This builder for chaining.

clearField(Descriptors.FieldDescriptor field)

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

clearName()

public Property.Builder clearName()

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

string name = 1;

Returns
TypeDescription
Property.Builder

This builder for chaining.

clearOneof(Descriptors.OneofDescriptor oneof)

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

clearType()

public Property.Builder clearType()

The type of this property.

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

Returns
TypeDescription
Property.Builder

This builder for chaining.

clone()

public Property.Builder clone()
Returns
TypeDescription
Property.Builder
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.

getDescriptorForType()

public Descriptors.Descriptor getDescriptorForType()
Returns
TypeDescription
Descriptor
Overrides

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.

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.

internalGetFieldAccessorTable()

protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Returns
TypeDescription
FieldAccessorTable
Overrides

isInitialized()

public final boolean isInitialized()
Returns
TypeDescription
boolean
Overrides

mergeFrom(Property other)

public Property.Builder mergeFrom(Property other)
Parameter
NameDescription
otherProperty
Returns
TypeDescription
Property.Builder

mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

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

mergeFrom(Message other)

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

mergeUnknownFields(UnknownFieldSet unknownFields)

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

setDescription(String value)

public Property.Builder setDescription(String value)

The description of the property

string description = 3;

Parameter
NameDescription
valueString

The description to set.

Returns
TypeDescription
Property.Builder

This builder for chaining.

setDescriptionBytes(ByteString value)

public Property.Builder setDescriptionBytes(ByteString value)

The description of the property

string description = 3;

Parameter
NameDescription
valueByteString

The bytes for description to set.

Returns
TypeDescription
Property.Builder

This builder for chaining.

setField(Descriptors.FieldDescriptor field, Object value)

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

setName(String value)

public Property.Builder setName(String value)

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

string name = 1;

Parameter
NameDescription
valueString

The name to set.

Returns
TypeDescription
Property.Builder

This builder for chaining.

setNameBytes(ByteString value)

public Property.Builder setNameBytes(ByteString value)

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

string name = 1;

Parameter
NameDescription
valueByteString

The bytes for name to set.

Returns
TypeDescription
Property.Builder

This builder for chaining.

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

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

setType(Property.PropertyType value)

public Property.Builder setType(Property.PropertyType value)

The type of this property.

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

Parameter
NameDescription
valueProperty.PropertyType

The type to set.

Returns
TypeDescription
Property.Builder

This builder for chaining.

setTypeValue(int value)

public Property.Builder setTypeValue(int value)

The type of this property.

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

Parameter
NameDescription
valueint

The enum numeric value on the wire for type to set.

Returns
TypeDescription
Property.Builder

This builder for chaining.

setUnknownFields(UnknownFieldSet unknownFields)

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