Class Http.Builder (2.24.0)

public static final class Http.Builder extends GeneratedMessageV3.Builder<Http.Builder> implements HttpOrBuilder

Defines the HTTP configuration for an API service. It contains a list of HttpRule, each specifying the mapping of an RPC method to one or more HTTP REST API methods.

Protobuf type google.api.Http

Inheritance

Object > AbstractMessageLite.Builder<MessageType,BuilderType> > AbstractMessage.Builder<BuilderType> > GeneratedMessageV3.Builder > Http.Builder

Implements

HttpOrBuilder

Inherited Members

AbstractMessage.Builder.findInitializationErrors()

AbstractMessage.Builder.getInitializationErrorString()

AbstractMessage.Builder.internalMergeFrom(AbstractMessageLite)

AbstractMessage.Builder.mergeFrom(byte[])

AbstractMessage.Builder.mergeFrom(byte[],ExtensionRegistryLite)

AbstractMessage.Builder.mergeFrom(byte[],int,int)

AbstractMessage.Builder.mergeFrom(byte[],int,int,ExtensionRegistryLite)

AbstractMessage.Builder.mergeFrom(ByteString)

AbstractMessage.Builder.mergeFrom(ByteString,ExtensionRegistryLite)

AbstractMessage.Builder.mergeFrom(CodedInputStream)

AbstractMessage.Builder.mergeFrom(CodedInputStream,ExtensionRegistryLite)

AbstractMessage.Builder.mergeFrom(Message)

AbstractMessage.Builder.mergeFrom(InputStream)

AbstractMessage.Builder.mergeFrom(InputStream,ExtensionRegistryLite)

AbstractMessage.Builder.newUninitializedMessageException(Message)

AbstractMessage.Builder.toString()

AbstractMessageLite.Builder.<T>addAll(Iterable<T>,Collection<? super T>)

AbstractMessageLite.Builder.<T>addAll(Iterable<T>,List<? super T>)

AbstractMessageLite.Builder.internalMergeFrom(MessageType)

AbstractMessageLite.Builder.mergeDelimitedFrom(InputStream)

AbstractMessageLite.Builder.mergeDelimitedFrom(InputStream,ExtensionRegistryLite)

AbstractMessageLite.Builder.mergeFrom(MessageLite)

AbstractMessageLite.Builder.newUninitializedMessageException(MessageLite)

GeneratedMessageV3.Builder.addRepeatedField(Descriptors.FieldDescriptor,Object)

GeneratedMessageV3.Builder.clear()

GeneratedMessageV3.Builder.clearField(Descriptors.FieldDescriptor)

GeneratedMessageV3.Builder.clearOneof(Descriptors.OneofDescriptor)

GeneratedMessageV3.Builder.clone()

GeneratedMessageV3.Builder.getAllFields()

GeneratedMessageV3.Builder.getDescriptorForType()

GeneratedMessageV3.Builder.getField(Descriptors.FieldDescriptor)

GeneratedMessageV3.Builder.getFieldBuilder(Descriptors.FieldDescriptor)

GeneratedMessageV3.Builder.getOneofFieldDescriptor(Descriptors.OneofDescriptor)

GeneratedMessageV3.Builder.getParentForChildren()

GeneratedMessageV3.Builder.getRepeatedField(Descriptors.FieldDescriptor,int)

GeneratedMessageV3.Builder.getRepeatedFieldBuilder(Descriptors.FieldDescriptor,int)

GeneratedMessageV3.Builder.getRepeatedFieldCount(Descriptors.FieldDescriptor)

com.google.protobuf.GeneratedMessageV3.Builder.getUnknownFieldSetBuilder()

GeneratedMessageV3.Builder.getUnknownFields()

GeneratedMessageV3.Builder.hasField(Descriptors.FieldDescriptor)

GeneratedMessageV3.Builder.hasOneof(Descriptors.OneofDescriptor)

GeneratedMessageV3.Builder.internalGetFieldAccessorTable()

GeneratedMessageV3.Builder.internalGetMapField(int)

GeneratedMessageV3.Builder.internalGetMutableMapField(int)

GeneratedMessageV3.Builder.isClean()

GeneratedMessageV3.Builder.isInitialized()

GeneratedMessageV3.Builder.markClean()

GeneratedMessageV3.Builder.mergeUnknownFields(UnknownFieldSet)

com.google.protobuf.GeneratedMessageV3.Builder.mergeUnknownLengthDelimitedField(int,com.google.protobuf.ByteString)

com.google.protobuf.GeneratedMessageV3.Builder.mergeUnknownVarintField(int,int)

GeneratedMessageV3.Builder.newBuilderForField(Descriptors.FieldDescriptor)

GeneratedMessageV3.Builder.onBuilt()

GeneratedMessageV3.Builder.onChanged()

com.google.protobuf.GeneratedMessageV3.Builder.parseUnknownField(com.google.protobuf.CodedInputStream,com.google.protobuf.ExtensionRegistryLite,int)

GeneratedMessageV3.Builder.setField(Descriptors.FieldDescriptor,Object)

GeneratedMessageV3.Builder.setRepeatedField(Descriptors.FieldDescriptor,int,Object)

com.google.protobuf.GeneratedMessageV3.Builder.setUnknownFieldSetBuilder(com.google.protobuf.UnknownFieldSet.Builder)

GeneratedMessageV3.Builder.setUnknownFields(UnknownFieldSet)

GeneratedMessageV3.Builder.setUnknownFieldsProto3(UnknownFieldSet)

Object.equals(Object)

Object.finalize()

Object.getClass()

Object.hashCode()

Object.notify()

Object.notifyAll()

Object.wait()

Object.wait(long)

Object.wait(long,int)

Static Methods

getDescriptor()

public static final Descriptors.Descriptor getDescriptor()

Returns
Type	Description
`Descriptor`

Methods

addAllRules(Iterable<? extends HttpRule> values)

public Http.Builder addAllRules(Iterable<? extends HttpRule> values)

A list of HTTP configuration rules that apply to individual API methods.

NOTE: All service configuration rules follow "last one wins" order.

repeated .google.api.HttpRule rules = 1;

Parameter
Name	Description
`values`	`Iterable<? extends com.google.api.HttpRule>`

Returns
Type	Description
`Http.Builder`

addRepeatedField(Descriptors.FieldDescriptor field, Object value)

public Http.Builder addRepeatedField(Descriptors.FieldDescriptor field, Object value)

Parameters
Name	Description
`field`	`FieldDescriptor`
`value`	`Object`

Returns
Type	Description
`Http.Builder`

Overrides

GeneratedMessageV3.Builder<BuilderType>.addRepeatedField(Descriptors.FieldDescriptor field, Object value)

addRules(HttpRule value)

public Http.Builder addRules(HttpRule value)

A list of HTTP configuration rules that apply to individual API methods.

NOTE: All service configuration rules follow "last one wins" order.

repeated .google.api.HttpRule rules = 1;

Parameter
Name	Description
`value`	`HttpRule`

Returns
Type	Description
`Http.Builder`

addRules(HttpRule.Builder builderForValue)

public Http.Builder addRules(HttpRule.Builder builderForValue)

A list of HTTP configuration rules that apply to individual API methods.

NOTE: All service configuration rules follow "last one wins" order.

repeated .google.api.HttpRule rules = 1;

Parameter
Name	Description
`builderForValue`	`HttpRule.Builder`

Returns
Type	Description
`Http.Builder`

addRules(int index, HttpRule value)

public Http.Builder addRules(int index, HttpRule value)

A list of HTTP configuration rules that apply to individual API methods.

NOTE: All service configuration rules follow "last one wins" order.

repeated .google.api.HttpRule rules = 1;

Parameters
Name	Description
`index`	`int`
`value`	`HttpRule`

Returns
Type	Description
`Http.Builder`

addRules(int index, HttpRule.Builder builderForValue)

public Http.Builder addRules(int index, HttpRule.Builder builderForValue)

A list of HTTP configuration rules that apply to individual API methods.

NOTE: All service configuration rules follow "last one wins" order.

repeated .google.api.HttpRule rules = 1;

Parameters
Name	Description
`index`	`int`
`builderForValue`	`HttpRule.Builder`

Returns
Type	Description
`Http.Builder`

addRulesBuilder()

public HttpRule.Builder addRulesBuilder()

A list of HTTP configuration rules that apply to individual API methods.

NOTE: All service configuration rules follow "last one wins" order.

repeated .google.api.HttpRule rules = 1;

Returns
Type	Description
`HttpRule.Builder`

addRulesBuilder(int index)

public HttpRule.Builder addRulesBuilder(int index)

A list of HTTP configuration rules that apply to individual API methods.

NOTE: All service configuration rules follow "last one wins" order.

repeated .google.api.HttpRule rules = 1;

Parameter
Name	Description
`index`	`int`

Returns
Type	Description
`HttpRule.Builder`

build()

public Http build()

Returns
Type	Description
`Http`

buildPartial()

public Http buildPartial()

Returns
Type	Description
`Http`

clear()

public Http.Builder clear()

Returns
Type	Description
`Http.Builder`

Overrides

GeneratedMessageV3.Builder<BuilderType>.clear()

clearField(Descriptors.FieldDescriptor field)

public Http.Builder clearField(Descriptors.FieldDescriptor field)

Parameter
Name	Description
`field`	`FieldDescriptor`

Returns
Type	Description
`Http.Builder`

Overrides

GeneratedMessageV3.Builder<BuilderType>.clearField(Descriptors.FieldDescriptor field)

clearFullyDecodeReservedExpansion()

public Http.Builder clearFullyDecodeReservedExpansion()

When set to true, URL path parameters will be fully URI-decoded except in cases of single segment matches in reserved expansion, where "%2F" will be left encoded.

The default behavior is to not decode RFC 6570 reserved characters in multi segment matches.

bool fully_decode_reserved_expansion = 2;

Returns
Type	Description
`Http.Builder`	This builder for chaining.

clearOneof(Descriptors.OneofDescriptor oneof)

public Http.Builder clearOneof(Descriptors.OneofDescriptor oneof)

Parameter
Name	Description
`oneof`	`OneofDescriptor`

Returns
Type	Description
`Http.Builder`

Overrides

GeneratedMessageV3.Builder<BuilderType>.clearOneof(Descriptors.OneofDescriptor oneof)

clearRules()

public Http.Builder clearRules()

A list of HTTP configuration rules that apply to individual API methods.

NOTE: All service configuration rules follow "last one wins" order.

repeated .google.api.HttpRule rules = 1;

Returns
Type	Description
`Http.Builder`

clone()

public Http.Builder clone()

Returns
Type	Description
`Http.Builder`

Overrides

GeneratedMessageV3.Builder<BuilderType>.clone()

getDefaultInstanceForType()

public Http getDefaultInstanceForType()

Returns
Type	Description
`Http`

getDescriptorForType()

public Descriptors.Descriptor getDescriptorForType()

Returns
Type	Description
`Descriptor`

Overrides

GeneratedMessageV3.Builder<BuilderType>.getDescriptorForType()

getFullyDecodeReservedExpansion()

public boolean getFullyDecodeReservedExpansion()

When set to true, URL path parameters will be fully URI-decoded except in cases of single segment matches in reserved expansion, where "%2F" will be left encoded.

The default behavior is to not decode RFC 6570 reserved characters in multi segment matches.

bool fully_decode_reserved_expansion = 2;

Returns
Type	Description
`boolean`	The fullyDecodeReservedExpansion.

getRules(int index)

public HttpRule getRules(int index)

A list of HTTP configuration rules that apply to individual API methods.

NOTE: All service configuration rules follow "last one wins" order.

repeated .google.api.HttpRule rules = 1;

Parameter
Name	Description
`index`	`int`

Returns
Type	Description
`HttpRule`

getRulesBuilder(int index)

public HttpRule.Builder getRulesBuilder(int index)

A list of HTTP configuration rules that apply to individual API methods.

NOTE: All service configuration rules follow "last one wins" order.

repeated .google.api.HttpRule rules = 1;

Parameter
Name	Description
`index`	`int`

Returns
Type	Description
`HttpRule.Builder`

getRulesBuilderList()

public List<HttpRule.Builder> getRulesBuilderList()

A list of HTTP configuration rules that apply to individual API methods.

NOTE: All service configuration rules follow "last one wins" order.

repeated .google.api.HttpRule rules = 1;

Returns
Type	Description
`List<Builder>`

getRulesCount()

public int getRulesCount()

A list of HTTP configuration rules that apply to individual API methods.

NOTE: All service configuration rules follow "last one wins" order.

repeated .google.api.HttpRule rules = 1;

Returns
Type	Description
`int`

getRulesList()

public List<HttpRule> getRulesList()

A list of HTTP configuration rules that apply to individual API methods.

NOTE: All service configuration rules follow "last one wins" order.

repeated .google.api.HttpRule rules = 1;

Returns
Type	Description
`List<HttpRule>`

getRulesOrBuilder(int index)

public HttpRuleOrBuilder getRulesOrBuilder(int index)

A list of HTTP configuration rules that apply to individual API methods.

NOTE: All service configuration rules follow "last one wins" order.

repeated .google.api.HttpRule rules = 1;

Parameter
Name	Description
`index`	`int`

Returns
Type	Description
`HttpRuleOrBuilder`

getRulesOrBuilderList()

public List<? extends HttpRuleOrBuilder> getRulesOrBuilderList()

A list of HTTP configuration rules that apply to individual API methods.

NOTE: All service configuration rules follow "last one wins" order.

repeated .google.api.HttpRule rules = 1;

Returns
Type	Description
`List<? extends com.google.api.HttpRuleOrBuilder>`

internalGetFieldAccessorTable()

protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()

Returns
Type	Description
`FieldAccessorTable`

Overrides

GeneratedMessageV3.Builder<BuilderType>.internalGetFieldAccessorTable()

isInitialized()

public final boolean isInitialized()

Returns
Type	Description
`boolean`

Overrides

GeneratedMessageV3.Builder<BuilderType>.isInitialized()

mergeFrom(Http other)

public Http.Builder mergeFrom(Http other)

Parameter
Name	Description
`other`	`Http`

Returns
Type	Description
`Http.Builder`

mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public Http.Builder mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

Parameters
Name	Description
`input`	`CodedInputStream`
`extensionRegistry`	`ExtensionRegistryLite`

Returns
Type	Description
`Http.Builder`

Overrides

AbstractMessage.Builder<BuilderType>.mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

Exceptions
Type	Description
`IOException`

mergeFrom(Message other)

public Http.Builder mergeFrom(Message other)

Parameter
Name	Description
`other`	`Message`

Returns
Type	Description
`Http.Builder`

Overrides

AbstractMessage.Builder<BuilderType>.mergeFrom(Message other)

mergeUnknownFields(UnknownFieldSet unknownFields)

public final Http.Builder mergeUnknownFields(UnknownFieldSet unknownFields)

Parameter
Name	Description
`unknownFields`	`UnknownFieldSet`

Returns
Type	Description
`Http.Builder`

Overrides

GeneratedMessageV3.Builder<BuilderType>.mergeUnknownFields(UnknownFieldSet unknownFields)

removeRules(int index)

public Http.Builder removeRules(int index)

A list of HTTP configuration rules that apply to individual API methods.

NOTE: All service configuration rules follow "last one wins" order.

repeated .google.api.HttpRule rules = 1;

Parameter
Name	Description
`index`	`int`

Returns
Type	Description
`Http.Builder`

setField(Descriptors.FieldDescriptor field, Object value)

public Http.Builder setField(Descriptors.FieldDescriptor field, Object value)

Parameters
Name	Description
`field`	`FieldDescriptor`
`value`	`Object`

Returns
Type	Description
`Http.Builder`

Overrides

GeneratedMessageV3.Builder<BuilderType>.setField(Descriptors.FieldDescriptor field, Object value)

setFullyDecodeReservedExpansion(boolean value)

public Http.Builder setFullyDecodeReservedExpansion(boolean value)

When set to true, URL path parameters will be fully URI-decoded except in cases of single segment matches in reserved expansion, where "%2F" will be left encoded.

The default behavior is to not decode RFC 6570 reserved characters in multi segment matches.

bool fully_decode_reserved_expansion = 2;

Parameter
Name	Description
`value`	`boolean` The fullyDecodeReservedExpansion to set.

Returns
Type	Description
`Http.Builder`	This builder for chaining.

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

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

Parameters
Name	Description
`field`	`FieldDescriptor`
`index`	`int`
`value`	`Object`

Returns
Type	Description
`Http.Builder`

Overrides

GeneratedMessageV3.Builder<BuilderType>.setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)

setRules(int index, HttpRule value)

public Http.Builder setRules(int index, HttpRule value)

A list of HTTP configuration rules that apply to individual API methods.

NOTE: All service configuration rules follow "last one wins" order.

repeated .google.api.HttpRule rules = 1;

Parameters
Name	Description
`index`	`int`
`value`	`HttpRule`

Returns
Type	Description
`Http.Builder`

setRules(int index, HttpRule.Builder builderForValue)

public Http.Builder setRules(int index, HttpRule.Builder builderForValue)

A list of HTTP configuration rules that apply to individual API methods.

NOTE: All service configuration rules follow "last one wins" order.

repeated .google.api.HttpRule rules = 1;

Parameters
Name	Description
`index`	`int`
`builderForValue`	`HttpRule.Builder`

Returns
Type	Description
`Http.Builder`

setUnknownFields(UnknownFieldSet unknownFields)

public final Http.Builder setUnknownFields(UnknownFieldSet unknownFields)

Parameter
Name	Description
`unknownFields`	`UnknownFieldSet`

Returns
Type	Description
`Http.Builder`

Overrides

GeneratedMessageV3.Builder<BuilderType>.setUnknownFields(UnknownFieldSet unknownFields)