Class Endpoint.Builder (2.8.4)

public static final class Endpoint.Builder extends GeneratedMessageV3.Builder<Endpoint.Builder> implements EndpointOrBuilder

Endpoint describes a network endpoint of a service that serves a set of APIs. It is commonly known as a service endpoint. A service may expose any number of service endpoints, and all service endpoints share the same service definition, such as quota limits and monitoring metrics. Example service configuration: name: library-example.googleapis.com endpoints:

Below entry makes 'google.example.library.v1.Library'

   # API be served from endpoint address library-example.googleapis.com.
   # It also allows HTTP OPTIONS calls to be passed to the backend, for
   # it to decide whether the subsequent cross-origin request is
   # allowed to proceed.
 - name: library-example.googleapis.com
   allow_cors: true

Protobuf type google.api.Endpoint

Inheritance

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

Implements

EndpointOrBuilder

Inherited Members

AbstractMessage.Builder.findInitializationErrors()

AbstractMessage.Builder.getInitializationErrorString()

AbstractMessage.Builder.internalMergeFrom(AbstractMessageLite)

AbstractMessage.Builder.mergeDelimitedFrom(InputStream)

AbstractMessage.Builder.mergeDelimitedFrom(InputStream,ExtensionRegistryLite)

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.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

addAliases(String value) (deprecated)

public Endpoint.Builder addAliases(String value)

Deprecated.

Unimplemented. Dot not use. DEPRECATED: This field is no longer supported. Instead of using aliases, please specify multiple google.api.Endpoint for each of the intended aliases. Additional names that this endpoint will be hosted on.

repeated string aliases = 2 [deprecated = true];

Parameter

Name	Description
value	`String` The aliases to add.

Returns

Type	Description
Endpoint.Builder	This builder for chaining.

addAliasesBytes(ByteString value) (deprecated)

public Endpoint.Builder addAliasesBytes(ByteString value)

Deprecated.

repeated string aliases = 2 [deprecated = true];

Parameter

Name	Description
value	`ByteString` The bytes of the aliases to add.

Returns

Type	Description
Endpoint.Builder	This builder for chaining.

addAllAliases(Iterable<String> values) (deprecated)

public Endpoint.Builder addAllAliases(Iterable<String> values)

Deprecated.

repeated string aliases = 2 [deprecated = true];

Parameter

Name	Description
values	`Iterable<String>` The aliases to add.

Returns

Type	Description
Endpoint.Builder	This builder for chaining.

addRepeatedField(Descriptors.FieldDescriptor field, Object value)

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

Parameters

Name	Description
field	`FieldDescriptor`
value	`Object`

Returns

Type	Description
Endpoint.Builder

Overrides

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

build()

public Endpoint build()

Returns

Type	Description
Endpoint

buildPartial()

public Endpoint buildPartial()

Returns

Type	Description
Endpoint

clear()

public Endpoint.Builder clear()

Returns

Type	Description
Endpoint.Builder

Overrides

GeneratedMessageV3.Builder<BuilderType>.clear()

clearAliases() (deprecated)

public Endpoint.Builder clearAliases()

Deprecated.

repeated string aliases = 2 [deprecated = true];

Returns

Type	Description
Endpoint.Builder	This builder for chaining.

clearAllowCors()

public Endpoint.Builder clearAllowCors()

Allowing CORS, aka cross-domain traffic, would allow the backends served from this endpoint to receive and respond to HTTP OPTIONS requests. The response will be used by the browser to determine whether the subsequent cross-origin request is allowed to proceed.

bool allow_cors = 5;

Returns

Type	Description
Endpoint.Builder	This builder for chaining.

clearField(Descriptors.FieldDescriptor field)

public Endpoint.Builder clearField(Descriptors.FieldDescriptor field)

Parameter

Name	Description
field	`FieldDescriptor`

Returns

Type	Description
Endpoint.Builder

Overrides

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

clearName()

public Endpoint.Builder clearName()

The canonical name of this endpoint.

string name = 1;

Returns

Type	Description
Endpoint.Builder	This builder for chaining.

clearOneof(Descriptors.OneofDescriptor oneof)

public Endpoint.Builder clearOneof(Descriptors.OneofDescriptor oneof)

Parameter

Name	Description
oneof	`OneofDescriptor`

Returns

Type	Description
Endpoint.Builder

Overrides

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

clearTarget()

public Endpoint.Builder clearTarget()

The specification of an Internet routable address of API frontend that will handle requests to this API Endpoint. It should be either a valid IPv4 address or a fully-qualified domain name. For example, "8.8.8.8" or "myservice.appspot.com".

string target = 101;

Returns

Type	Description
Endpoint.Builder	This builder for chaining.

clone()

public Endpoint.Builder clone()

Returns

Type	Description
Endpoint.Builder

Overrides

GeneratedMessageV3.Builder<BuilderType>.clone()

getAliases(int index) (deprecated)

public String getAliases(int index)

Deprecated.

repeated string aliases = 2 [deprecated = true];

Parameter

Name	Description
index	`int` The index of the element to return.

Returns

Type	Description
String	The aliases at the given index.

getAliasesBytes(int index) (deprecated)

public ByteString getAliasesBytes(int index)

Deprecated.

repeated string aliases = 2 [deprecated = true];

Parameter

Name	Description
index	`int` The index of the value to return.

Returns

Type	Description
ByteString	The bytes of the aliases at the given index.

getAliasesCount() (deprecated)

public int getAliasesCount()

Deprecated.

repeated string aliases = 2 [deprecated = true];

Returns

Type	Description
int	The count of aliases.

getAliasesList() (deprecated)

public ProtocolStringList getAliasesList()

Deprecated.

repeated string aliases = 2 [deprecated = true];

Returns

Type	Description
ProtocolStringList	A list containing the aliases.

getAllowCors()

public boolean getAllowCors()

bool allow_cors = 5;

Returns

Type	Description
boolean	The allowCors.

getDefaultInstanceForType()

public Endpoint getDefaultInstanceForType()

Returns

Type	Description
Endpoint

getDescriptorForType()

public Descriptors.Descriptor getDescriptorForType()

Returns

Type	Description
Descriptor

Overrides

GeneratedMessageV3.Builder<BuilderType>.getDescriptorForType()

getName()

public String getName()

The canonical name of this endpoint.

string name = 1;

Returns

Type	Description
String	The name.

getNameBytes()

public ByteString getNameBytes()

The canonical name of this endpoint.

string name = 1;

Returns

Type	Description
ByteString	The bytes for name.

getTarget()

public String getTarget()

string target = 101;

Returns

Type	Description
String	The target.

getTargetBytes()

public ByteString getTargetBytes()

string target = 101;

Returns

Type	Description
ByteString	The bytes for target.

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(Endpoint other)

public Endpoint.Builder mergeFrom(Endpoint other)

Parameter

Name	Description
other	`Endpoint`

Returns

Type	Description
Endpoint.Builder

mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

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

Parameters

Name	Description
input	`CodedInputStream`
extensionRegistry	`ExtensionRegistryLite`

Returns

Type	Description
Endpoint.Builder

Overrides

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

Exceptions

Type	Description
IOException

mergeFrom(Message other)

public Endpoint.Builder mergeFrom(Message other)

Parameter

Name	Description
other	`Message`

Returns

Type	Description
Endpoint.Builder

Overrides

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

mergeUnknownFields(UnknownFieldSet unknownFields)

public final Endpoint.Builder mergeUnknownFields(UnknownFieldSet unknownFields)

Parameter

Name	Description
unknownFields	`UnknownFieldSet`

Returns

Type	Description
Endpoint.Builder

Overrides

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

setAliases(int index, String value) (deprecated)

public Endpoint.Builder setAliases(int index, String value)

Deprecated.

repeated string aliases = 2 [deprecated = true];

Parameters

Name	Description
index	`int` The index to set the value at.
value	`String` The aliases to set.

Returns

Type	Description
Endpoint.Builder	This builder for chaining.

setAllowCors(boolean value)

public Endpoint.Builder setAllowCors(boolean value)

bool allow_cors = 5;

Parameter

Name	Description
value	`boolean` The allowCors to set.

Returns

Type	Description
Endpoint.Builder	This builder for chaining.

setField(Descriptors.FieldDescriptor field, Object value)

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

Parameters

Name	Description
field	`FieldDescriptor`
value	`Object`

Returns

Type	Description
Endpoint.Builder

Overrides

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

setName(String value)

public Endpoint.Builder setName(String value)

The canonical name of this endpoint.

string name = 1;

Parameter

Name	Description
value	`String` The name to set.

Returns

Type	Description
Endpoint.Builder	This builder for chaining.

setNameBytes(ByteString value)

public Endpoint.Builder setNameBytes(ByteString value)

The canonical name of this endpoint.

string name = 1;

Parameter

Name	Description
value	`ByteString` The bytes for name to set.

Returns

Type	Description
Endpoint.Builder	This builder for chaining.

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

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

Parameters

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

Returns

Type	Description
Endpoint.Builder

Overrides

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

setTarget(String value)

public Endpoint.Builder setTarget(String value)

string target = 101;

Parameter

Name	Description
value	`String` The target to set.

Returns

Type	Description
Endpoint.Builder	This builder for chaining.

setTargetBytes(ByteString value)

public Endpoint.Builder setTargetBytes(ByteString value)

string target = 101;

Parameter

Name	Description
value	`ByteString` The bytes for target to set.

Returns

Type	Description
Endpoint.Builder	This builder for chaining.

setUnknownFields(UnknownFieldSet unknownFields)

public final Endpoint.Builder setUnknownFields(UnknownFieldSet unknownFields)

Parameter

Name	Description
unknownFields	`UnknownFieldSet`

Returns

Type	Description
Endpoint.Builder

Overrides

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