public static final class Endpoint.Builder extends GeneratedMessageV3.Builder<Endpoint.Builder> implements EndpointOrBuilder
`Endpoint` describes a network endpoint that serves a set of APIs.
A service may expose any number of endpoints, and all endpoints share the
same service configuration, such as quota configuration and monitoring
configuration.
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| Modifier and Type | Method and Description |
|---|---|
Endpoint.Builder |
addAliases(java.lang.String value)
Deprecated.
|
Endpoint.Builder |
addAliasesBytes(ByteString value)
Deprecated.
|
Endpoint.Builder |
addAllAliases(java.lang.Iterable<java.lang.String> values)
Deprecated.
|
Endpoint.Builder |
addAllFeatures(java.lang.Iterable<java.lang.String> values)
The list of features enabled on this endpoint.
|
Endpoint.Builder |
addFeatures(java.lang.String value)
The list of features enabled on this endpoint.
|
Endpoint.Builder |
addFeaturesBytes(ByteString value)
The list of features enabled on this endpoint.
|
Endpoint.Builder |
addRepeatedField(Descriptors.FieldDescriptor field,
java.lang.Object value) |
Endpoint |
build() |
Endpoint |
buildPartial() |
Endpoint.Builder |
clear() |
Endpoint.Builder |
clearAliases()
Deprecated.
|
Endpoint.Builder |
clearAllowCors()
Allowing
[CORS](https://en.wikipedia.org/wiki/Cross-origin_resource_sharing), aka
cross-domain traffic, would allow the backends served from this endpoint to
receive and respond to HTTP OPTIONS requests.
|
Endpoint.Builder |
clearFeatures()
The list of features enabled on this endpoint.
|
Endpoint.Builder |
clearField(Descriptors.FieldDescriptor field) |
Endpoint.Builder |
clearName()
The canonical name of this endpoint.
|
Endpoint.Builder |
clearOneof(Descriptors.OneofDescriptor oneof) |
Endpoint.Builder |
clearTarget()
The specification of an Internet routable address of API frontend that will
handle requests to this [API
Endpoint](https://cloud.google.com/apis/design/glossary).
|
Endpoint.Builder |
clone() |
java.lang.String |
getAliases(int index)
Deprecated.
|
ByteString |
getAliasesBytes(int index)
Deprecated.
|
int |
getAliasesCount()
Deprecated.
|
ProtocolStringList |
getAliasesList()
Deprecated.
|
boolean |
getAllowCors()
Allowing
[CORS](https://en.wikipedia.org/wiki/Cross-origin_resource_sharing), aka
cross-domain traffic, would allow the backends served from this endpoint to
receive and respond to HTTP OPTIONS requests.
|
Endpoint |
getDefaultInstanceForType() |
static Descriptors.Descriptor |
getDescriptor() |
Descriptors.Descriptor |
getDescriptorForType() |
java.lang.String |
getFeatures(int index)
The list of features enabled on this endpoint.
|
ByteString |
getFeaturesBytes(int index)
The list of features enabled on this endpoint.
|
int |
getFeaturesCount()
The list of features enabled on this endpoint.
|
ProtocolStringList |
getFeaturesList()
The list of features enabled on this endpoint.
|
java.lang.String |
getName()
The canonical name of this endpoint.
|
ByteString |
getNameBytes()
The canonical name of this endpoint.
|
java.lang.String |
getTarget()
The specification of an Internet routable address of API frontend that will
handle requests to this [API
Endpoint](https://cloud.google.com/apis/design/glossary).
|
ByteString |
getTargetBytes()
The specification of an Internet routable address of API frontend that will
handle requests to this [API
Endpoint](https://cloud.google.com/apis/design/glossary).
|
protected GeneratedMessageV3.FieldAccessorTable |
internalGetFieldAccessorTable() |
boolean |
isInitialized() |
Endpoint.Builder |
mergeFrom(CodedInputStream input,
ExtensionRegistryLite extensionRegistry) |
Endpoint.Builder |
mergeFrom(Endpoint other) |
Endpoint.Builder |
mergeFrom(Message other) |
Endpoint.Builder |
mergeUnknownFields(UnknownFieldSet unknownFields) |
Endpoint.Builder |
setAliases(int index,
java.lang.String value)
Deprecated.
|
Endpoint.Builder |
setAllowCors(boolean value)
Allowing
[CORS](https://en.wikipedia.org/wiki/Cross-origin_resource_sharing), aka
cross-domain traffic, would allow the backends served from this endpoint to
receive and respond to HTTP OPTIONS requests.
|
Endpoint.Builder |
setFeatures(int index,
java.lang.String value)
The list of features enabled on this endpoint.
|
Endpoint.Builder |
setField(Descriptors.FieldDescriptor field,
java.lang.Object value) |
Endpoint.Builder |
setName(java.lang.String value)
The canonical name of this endpoint.
|
Endpoint.Builder |
setNameBytes(ByteString value)
The canonical name of this endpoint.
|
Endpoint.Builder |
setRepeatedField(Descriptors.FieldDescriptor field,
int index,
java.lang.Object value) |
Endpoint.Builder |
setTarget(java.lang.String value)
The specification of an Internet routable address of API frontend that will
handle requests to this [API
Endpoint](https://cloud.google.com/apis/design/glossary).
|
Endpoint.Builder |
setTargetBytes(ByteString value)
The specification of an Internet routable address of API frontend that will
handle requests to this [API
Endpoint](https://cloud.google.com/apis/design/glossary).
|
Endpoint.Builder |
setUnknownFields(UnknownFieldSet unknownFields) |
getAllFields, getField, getFieldBuilder, getOneofFieldDescriptor, getParentForChildren, getRepeatedField, getRepeatedFieldBuilder, getRepeatedFieldCount, getUnknownFields, hasField, hasOneof, internalGetMapField, internalGetMutableMapField, isClean, markClean, newBuilderForField, onBuilt, onChanged, setUnknownFieldsProto3findInitializationErrors, getInitializationErrorString, internalMergeFrom, mergeDelimitedFrom, mergeDelimitedFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, newUninitializedMessageException, toStringaddAll, addAll, mergeFrom, newUninitializedMessageExceptionequals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, waitfindInitializationErrors, getAllFields, getField, getInitializationErrorString, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, getUnknownFields, hasField, hasOneofmergeFrompublic static final Descriptors.Descriptor getDescriptor()
protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
internalGetFieldAccessorTable in class GeneratedMessageV3.Builder<Endpoint.Builder>public Endpoint.Builder clear()
clear in interface Message.Builderclear in interface MessageLite.Builderclear in class GeneratedMessageV3.Builder<Endpoint.Builder>public Descriptors.Descriptor getDescriptorForType()
getDescriptorForType in interface Message.BuildergetDescriptorForType in interface MessageOrBuildergetDescriptorForType in class GeneratedMessageV3.Builder<Endpoint.Builder>public Endpoint getDefaultInstanceForType()
getDefaultInstanceForType in interface MessageLiteOrBuildergetDefaultInstanceForType in interface MessageOrBuilderpublic Endpoint build()
build in interface Message.Builderbuild in interface MessageLite.Builderpublic Endpoint buildPartial()
buildPartial in interface Message.BuilderbuildPartial in interface MessageLite.Builderpublic Endpoint.Builder clone()
clone in interface Message.Builderclone in interface MessageLite.Builderclone in class GeneratedMessageV3.Builder<Endpoint.Builder>public Endpoint.Builder setField(Descriptors.FieldDescriptor field, java.lang.Object value)
setField in interface Message.BuildersetField in class GeneratedMessageV3.Builder<Endpoint.Builder>public Endpoint.Builder clearField(Descriptors.FieldDescriptor field)
clearField in interface Message.BuilderclearField in class GeneratedMessageV3.Builder<Endpoint.Builder>public Endpoint.Builder clearOneof(Descriptors.OneofDescriptor oneof)
clearOneof in interface Message.BuilderclearOneof in class GeneratedMessageV3.Builder<Endpoint.Builder>public Endpoint.Builder setRepeatedField(Descriptors.FieldDescriptor field, int index, java.lang.Object value)
setRepeatedField in interface Message.BuildersetRepeatedField in class GeneratedMessageV3.Builder<Endpoint.Builder>public Endpoint.Builder addRepeatedField(Descriptors.FieldDescriptor field, java.lang.Object value)
addRepeatedField in interface Message.BuilderaddRepeatedField in class GeneratedMessageV3.Builder<Endpoint.Builder>public Endpoint.Builder mergeFrom(Message other)
mergeFrom in interface Message.BuildermergeFrom in class AbstractMessage.Builder<Endpoint.Builder>public Endpoint.Builder mergeFrom(Endpoint other)
public final boolean isInitialized()
isInitialized in interface MessageLiteOrBuilderisInitialized in class GeneratedMessageV3.Builder<Endpoint.Builder>public Endpoint.Builder mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry) throws java.io.IOException
mergeFrom in interface Message.BuildermergeFrom in interface MessageLite.BuildermergeFrom in class AbstractMessage.Builder<Endpoint.Builder>java.io.IOExceptionpublic java.lang.String getName()
The canonical name of this endpoint.
string name = 1;getName in interface EndpointOrBuilderpublic ByteString getNameBytes()
The canonical name of this endpoint.
string name = 1;getNameBytes in interface EndpointOrBuilderpublic Endpoint.Builder setName(java.lang.String value)
The canonical name of this endpoint.
string name = 1;public Endpoint.Builder clearName()
The canonical name of this endpoint.
string name = 1;public Endpoint.Builder setNameBytes(ByteString value)
The canonical name of this endpoint.
string name = 1;@Deprecated public ProtocolStringList getAliasesList()
DEPRECATED: This field is no longer supported. Instead of using aliases, please specify multiple [google.api.Endpoint][google.api.Endpoint] for each of the intended aliases. Additional names that this endpoint will be hosted on.
repeated string aliases = 2 [deprecated = true];getAliasesList in interface EndpointOrBuilder@Deprecated public int getAliasesCount()
DEPRECATED: This field is no longer supported. Instead of using aliases, please specify multiple [google.api.Endpoint][google.api.Endpoint] for each of the intended aliases. Additional names that this endpoint will be hosted on.
repeated string aliases = 2 [deprecated = true];getAliasesCount in interface EndpointOrBuilder@Deprecated public java.lang.String getAliases(int index)
DEPRECATED: This field is no longer supported. Instead of using aliases, please specify multiple [google.api.Endpoint][google.api.Endpoint] for each of the intended aliases. Additional names that this endpoint will be hosted on.
repeated string aliases = 2 [deprecated = true];getAliases in interface EndpointOrBuilder@Deprecated public ByteString getAliasesBytes(int index)
DEPRECATED: This field is no longer supported. Instead of using aliases, please specify multiple [google.api.Endpoint][google.api.Endpoint] for each of the intended aliases. Additional names that this endpoint will be hosted on.
repeated string aliases = 2 [deprecated = true];getAliasesBytes in interface EndpointOrBuilder@Deprecated public Endpoint.Builder setAliases(int index, java.lang.String value)
DEPRECATED: This field is no longer supported. Instead of using aliases, please specify multiple [google.api.Endpoint][google.api.Endpoint] for each of the intended aliases. Additional names that this endpoint will be hosted on.
repeated string aliases = 2 [deprecated = true];@Deprecated public Endpoint.Builder addAliases(java.lang.String value)
DEPRECATED: This field is no longer supported. Instead of using aliases, please specify multiple [google.api.Endpoint][google.api.Endpoint] for each of the intended aliases. Additional names that this endpoint will be hosted on.
repeated string aliases = 2 [deprecated = true];@Deprecated public Endpoint.Builder addAllAliases(java.lang.Iterable<java.lang.String> values)
DEPRECATED: This field is no longer supported. Instead of using aliases, please specify multiple [google.api.Endpoint][google.api.Endpoint] for each of the intended aliases. Additional names that this endpoint will be hosted on.
repeated string aliases = 2 [deprecated = true];@Deprecated public Endpoint.Builder clearAliases()
DEPRECATED: This field is no longer supported. Instead of using aliases, please specify multiple [google.api.Endpoint][google.api.Endpoint] for each of the intended aliases. Additional names that this endpoint will be hosted on.
repeated string aliases = 2 [deprecated = true];@Deprecated public Endpoint.Builder addAliasesBytes(ByteString value)
DEPRECATED: This field is no longer supported. Instead of using aliases, please specify multiple [google.api.Endpoint][google.api.Endpoint] for each of the intended aliases. Additional names that this endpoint will be hosted on.
repeated string aliases = 2 [deprecated = true];public ProtocolStringList getFeaturesList()
The list of features enabled on this endpoint.
repeated string features = 4;getFeaturesList in interface EndpointOrBuilderpublic int getFeaturesCount()
The list of features enabled on this endpoint.
repeated string features = 4;getFeaturesCount in interface EndpointOrBuilderpublic java.lang.String getFeatures(int index)
The list of features enabled on this endpoint.
repeated string features = 4;getFeatures in interface EndpointOrBuilderpublic ByteString getFeaturesBytes(int index)
The list of features enabled on this endpoint.
repeated string features = 4;getFeaturesBytes in interface EndpointOrBuilderpublic Endpoint.Builder setFeatures(int index, java.lang.String value)
The list of features enabled on this endpoint.
repeated string features = 4;public Endpoint.Builder addFeatures(java.lang.String value)
The list of features enabled on this endpoint.
repeated string features = 4;public Endpoint.Builder addAllFeatures(java.lang.Iterable<java.lang.String> values)
The list of features enabled on this endpoint.
repeated string features = 4;public Endpoint.Builder clearFeatures()
The list of features enabled on this endpoint.
repeated string features = 4;public Endpoint.Builder addFeaturesBytes(ByteString value)
The list of features enabled on this endpoint.
repeated string features = 4;public java.lang.String getTarget()
The specification of an Internet routable address of API frontend that will handle requests to this [API Endpoint](https://cloud.google.com/apis/design/glossary). 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;getTarget in interface EndpointOrBuilderpublic ByteString getTargetBytes()
The specification of an Internet routable address of API frontend that will handle requests to this [API Endpoint](https://cloud.google.com/apis/design/glossary). 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;getTargetBytes in interface EndpointOrBuilderpublic Endpoint.Builder setTarget(java.lang.String value)
The specification of an Internet routable address of API frontend that will handle requests to this [API Endpoint](https://cloud.google.com/apis/design/glossary). 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;public Endpoint.Builder clearTarget()
The specification of an Internet routable address of API frontend that will handle requests to this [API Endpoint](https://cloud.google.com/apis/design/glossary). 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;public Endpoint.Builder setTargetBytes(ByteString value)
The specification of an Internet routable address of API frontend that will handle requests to this [API Endpoint](https://cloud.google.com/apis/design/glossary). 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;public boolean getAllowCors()
Allowing [CORS](https://en.wikipedia.org/wiki/Cross-origin_resource_sharing), 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;getAllowCors in interface EndpointOrBuilderpublic Endpoint.Builder setAllowCors(boolean value)
Allowing [CORS](https://en.wikipedia.org/wiki/Cross-origin_resource_sharing), 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;public Endpoint.Builder clearAllowCors()
Allowing [CORS](https://en.wikipedia.org/wiki/Cross-origin_resource_sharing), 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;public final Endpoint.Builder setUnknownFields(UnknownFieldSet unknownFields)
setUnknownFields in interface Message.BuildersetUnknownFields in class GeneratedMessageV3.Builder<Endpoint.Builder>public final Endpoint.Builder mergeUnknownFields(UnknownFieldSet unknownFields)
mergeUnknownFields in interface Message.BuildermergeUnknownFields in class GeneratedMessageV3.Builder<Endpoint.Builder>