public static final class Property.Builder extends GeneratedMessageV3.Builder<Property.Builder> implements PropertyOrBuilderDefines 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
Inheritance
Object > AbstractMessageLite.Builder<MessageType,BuilderType> > AbstractMessage.Builder<BuilderType> > GeneratedMessageV3.Builder > Property.BuilderImplements
PropertyOrBuilderStatic Methods
getDescriptor()
public static final Descriptors.Descriptor getDescriptor()| Returns | |
|---|---|
| Type | Description |
Descriptor |
|
Methods
addRepeatedField(Descriptors.FieldDescriptor field, Object value)
public Property.Builder addRepeatedField(Descriptors.FieldDescriptor field, Object value)| Parameters | |
|---|---|
| Name | Description |
field |
FieldDescriptor |
value |
Object |
| Returns | |
|---|---|
| Type | Description |
Property.Builder |
|
build()
public Property build()| Returns | |
|---|---|
| Type | Description |
Property |
|
buildPartial()
public Property buildPartial()| Returns | |
|---|---|
| Type | Description |
Property |
|
clear()
public Property.Builder clear()| Returns | |
|---|---|
| Type | Description |
Property.Builder |
|
clearDescription()
public Property.Builder clearDescription()The description of the property
string description = 3;
| Returns | |
|---|---|
| Type | Description |
Property.Builder |
This builder for chaining. |
clearField(Descriptors.FieldDescriptor field)
public Property.Builder clearField(Descriptors.FieldDescriptor field)| Parameter | |
|---|---|
| Name | Description |
field |
FieldDescriptor |
| Returns | |
|---|---|
| Type | Description |
Property.Builder |
|
clearName()
public Property.Builder clearName()The name of the property (a.k.a key).
string name = 1;
| Returns | |
|---|---|
| Type | Description |
Property.Builder |
This builder for chaining. |
clearOneof(Descriptors.OneofDescriptor oneof)
public Property.Builder clearOneof(Descriptors.OneofDescriptor oneof)| Parameter | |
|---|---|
| Name | Description |
oneof |
OneofDescriptor |
| Returns | |
|---|---|
| Type | Description |
Property.Builder |
|
clearType()
public Property.Builder clearType()The type of this property.
.google.api.Property.PropertyType type = 2;
| Returns | |
|---|---|
| Type | Description |
Property.Builder |
This builder for chaining. |
clone()
public Property.Builder clone()| Returns | |
|---|---|
| Type | Description |
Property.Builder |
|
getDefaultInstanceForType()
public Property getDefaultInstanceForType()| Returns | |
|---|---|
| Type | Description |
Property |
|
getDescription()
public String getDescription()The description of the property
string description = 3;
| Returns | |
|---|---|
| Type | Description |
String |
The description. |
getDescriptionBytes()
public ByteString getDescriptionBytes()The description of the property
string description = 3;
| Returns | |
|---|---|
| Type | Description |
ByteString |
The bytes for description. |
getDescriptorForType()
public Descriptors.Descriptor getDescriptorForType()| Returns | |
|---|---|
| Type | Description |
Descriptor |
|
getName()
public String getName()The name of the property (a.k.a key).
string name = 1;
| Returns | |
|---|---|
| Type | Description |
String |
The name. |
getNameBytes()
public ByteString getNameBytes()The name of the property (a.k.a key).
string name = 1;
| Returns | |
|---|---|
| Type | Description |
ByteString |
The bytes for name. |
getType()
public Property.PropertyType getType()The type of this property.
.google.api.Property.PropertyType type = 2;
| Returns | |
|---|---|
| Type | Description |
Property.PropertyType |
The type. |
getTypeValue()
public int getTypeValue()The type of this property.
.google.api.Property.PropertyType type = 2;
| Returns | |
|---|---|
| Type | Description |
int |
The enum numeric value on the wire for type. |
internalGetFieldAccessorTable()
protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()| Returns | |
|---|---|
| Type | Description |
FieldAccessorTable |
|
isInitialized()
public final boolean isInitialized()| Returns | |
|---|---|
| Type | Description |
boolean |
|
mergeFrom(Property other)
public Property.Builder mergeFrom(Property other)| Parameter | |
|---|---|
| Name | Description |
other |
Property |
| Returns | |
|---|---|
| Type | Description |
Property.Builder |
|
mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
public Property.Builder mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)| Parameters | |
|---|---|
| Name | Description |
input |
CodedInputStream |
extensionRegistry |
ExtensionRegistryLite |
| Returns | |
|---|---|
| Type | Description |
Property.Builder |
|
| Exceptions | |
|---|---|
| Type | Description |
IOException |
|
mergeFrom(Message other)
public Property.Builder mergeFrom(Message other)| Parameter | |
|---|---|
| Name | Description |
other |
Message |
| Returns | |
|---|---|
| Type | Description |
Property.Builder |
|
mergeUnknownFields(UnknownFieldSet unknownFields)
public final Property.Builder mergeUnknownFields(UnknownFieldSet unknownFields)| Parameter | |
|---|---|
| Name | Description |
unknownFields |
UnknownFieldSet |
| Returns | |
|---|---|
| Type | Description |
Property.Builder |
|
setDescription(String value)
public Property.Builder setDescription(String value)The description of the property
string description = 3;
| Parameter | |
|---|---|
| Name | Description |
value |
StringThe description to set. |
| Returns | |
|---|---|
| Type | Description |
Property.Builder |
This builder for chaining. |
setDescriptionBytes(ByteString value)
public Property.Builder setDescriptionBytes(ByteString value)The description of the property
string description = 3;
| Parameter | |
|---|---|
| Name | Description |
value |
ByteStringThe bytes for description to set. |
| Returns | |
|---|---|
| Type | Description |
Property.Builder |
This builder for chaining. |
setField(Descriptors.FieldDescriptor field, Object value)
public Property.Builder setField(Descriptors.FieldDescriptor field, Object value)| Parameters | |
|---|---|
| Name | Description |
field |
FieldDescriptor |
value |
Object |
| Returns | |
|---|---|
| Type | Description |
Property.Builder |
|
setName(String value)
public Property.Builder setName(String value)The name of the property (a.k.a key).
string name = 1;
| Parameter | |
|---|---|
| Name | Description |
value |
StringThe name to set. |
| Returns | |
|---|---|
| Type | Description |
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 | |
|---|---|
| Name | Description |
value |
ByteStringThe bytes for name to set. |
| Returns | |
|---|---|
| Type | Description |
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 | |
|---|---|
| Name | Description |
field |
FieldDescriptor |
index |
int |
value |
Object |
| Returns | |
|---|---|
| Type | Description |
Property.Builder |
|
setType(Property.PropertyType value)
public Property.Builder setType(Property.PropertyType value)The type of this property.
.google.api.Property.PropertyType type = 2;
| Parameter | |
|---|---|
| Name | Description |
value |
Property.PropertyTypeThe type to set. |
| Returns | |
|---|---|
| Type | Description |
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 | |
|---|---|
| Name | Description |
value |
intThe enum numeric value on the wire for type to set. |
| Returns | |
|---|---|
| Type | Description |
Property.Builder |
This builder for chaining. |
setUnknownFields(UnknownFieldSet unknownFields)
public final Property.Builder setUnknownFields(UnknownFieldSet unknownFields)| Parameter | |
|---|---|
| Name | Description |
unknownFields |
UnknownFieldSet |
| Returns | |
|---|---|
| Type | Description |
Property.Builder |
|