public static final class Endpoint.Builder extends com.google.protobuf.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(com.google.protobuf.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(com.google.protobuf.ByteString value)
The list of features enabled on this endpoint.
|
Endpoint.Builder |
addRepeatedField(com.google.protobuf.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(com.google.protobuf.Descriptors.FieldDescriptor field) |
Endpoint.Builder |
clearName()
The canonical name of this endpoint.
|
Endpoint.Builder |
clearOneof(com.google.protobuf.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.
|
com.google.protobuf.ByteString |
getAliasesBytes(int index)
Deprecated.
|
int |
getAliasesCount()
Deprecated.
|
com.google.protobuf.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 com.google.protobuf.Descriptors.Descriptor |
getDescriptor() |
com.google.protobuf.Descriptors.Descriptor |
getDescriptorForType() |
java.lang.String |
getFeatures(int index)
The list of features enabled on this endpoint.
|
com.google.protobuf.ByteString |
getFeaturesBytes(int index)
The list of features enabled on this endpoint.
|
int |
getFeaturesCount()
The list of features enabled on this endpoint.
|
com.google.protobuf.ProtocolStringList |
getFeaturesList()
The list of features enabled on this endpoint.
|
java.lang.String |
getName()
The canonical name of this endpoint.
|
com.google.protobuf.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).
|
com.google.protobuf.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 com.google.protobuf.GeneratedMessageV3.FieldAccessorTable |
internalGetFieldAccessorTable() |
boolean |
isInitialized() |
Endpoint.Builder |
mergeFrom(com.google.protobuf.CodedInputStream input,
com.google.protobuf.ExtensionRegistryLite extensionRegistry) |
Endpoint.Builder |
mergeFrom(Endpoint other) |
Endpoint.Builder |
mergeFrom(com.google.protobuf.Message other) |
Endpoint.Builder |
mergeUnknownFields(com.google.protobuf.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(com.google.protobuf.Descriptors.FieldDescriptor field,
java.lang.Object value) |
Endpoint.Builder |
setName(java.lang.String value)
The canonical name of this endpoint.
|
Endpoint.Builder |
setNameBytes(com.google.protobuf.ByteString value)
The canonical name of this endpoint.
|
Endpoint.Builder |
setRepeatedField(com.google.protobuf.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(com.google.protobuf.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(com.google.protobuf.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, waitpublic static final com.google.protobuf.Descriptors.Descriptor getDescriptor()
protected com.google.protobuf.GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
internalGetFieldAccessorTable in class com.google.protobuf.GeneratedMessageV3.Builder<Endpoint.Builder>public Endpoint.Builder clear()
clear in interface com.google.protobuf.Message.Builderclear in interface com.google.protobuf.MessageLite.Builderclear in class com.google.protobuf.GeneratedMessageV3.Builder<Endpoint.Builder>public com.google.protobuf.Descriptors.Descriptor getDescriptorForType()
getDescriptorForType in interface com.google.protobuf.Message.BuildergetDescriptorForType in interface com.google.protobuf.MessageOrBuildergetDescriptorForType in class com.google.protobuf.GeneratedMessageV3.Builder<Endpoint.Builder>public Endpoint getDefaultInstanceForType()
getDefaultInstanceForType in interface com.google.protobuf.MessageLiteOrBuildergetDefaultInstanceForType in interface com.google.protobuf.MessageOrBuilderpublic Endpoint build()
build in interface com.google.protobuf.Message.Builderbuild in interface com.google.protobuf.MessageLite.Builderpublic Endpoint buildPartial()
buildPartial in interface com.google.protobuf.Message.BuilderbuildPartial in interface com.google.protobuf.MessageLite.Builderpublic Endpoint.Builder clone()
clone in interface com.google.protobuf.Message.Builderclone in interface com.google.protobuf.MessageLite.Builderclone in class com.google.protobuf.GeneratedMessageV3.Builder<Endpoint.Builder>public Endpoint.Builder setField(com.google.protobuf.Descriptors.FieldDescriptor field, java.lang.Object value)
setField in interface com.google.protobuf.Message.BuildersetField in class com.google.protobuf.GeneratedMessageV3.Builder<Endpoint.Builder>public Endpoint.Builder clearField(com.google.protobuf.Descriptors.FieldDescriptor field)
clearField in interface com.google.protobuf.Message.BuilderclearField in class com.google.protobuf.GeneratedMessageV3.Builder<Endpoint.Builder>public Endpoint.Builder clearOneof(com.google.protobuf.Descriptors.OneofDescriptor oneof)
clearOneof in interface com.google.protobuf.Message.BuilderclearOneof in class com.google.protobuf.GeneratedMessageV3.Builder<Endpoint.Builder>public Endpoint.Builder setRepeatedField(com.google.protobuf.Descriptors.FieldDescriptor field, int index, java.lang.Object value)
setRepeatedField in interface com.google.protobuf.Message.BuildersetRepeatedField in class com.google.protobuf.GeneratedMessageV3.Builder<Endpoint.Builder>public Endpoint.Builder addRepeatedField(com.google.protobuf.Descriptors.FieldDescriptor field, java.lang.Object value)
addRepeatedField in interface com.google.protobuf.Message.BuilderaddRepeatedField in class com.google.protobuf.GeneratedMessageV3.Builder<Endpoint.Builder>public Endpoint.Builder mergeFrom(com.google.protobuf.Message other)
mergeFrom in interface com.google.protobuf.Message.BuildermergeFrom in class com.google.protobuf.AbstractMessage.Builder<Endpoint.Builder>public Endpoint.Builder mergeFrom(Endpoint other)
public final boolean isInitialized()
isInitialized in interface com.google.protobuf.MessageLiteOrBuilderisInitialized in class com.google.protobuf.GeneratedMessageV3.Builder<Endpoint.Builder>public Endpoint.Builder mergeFrom(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws java.io.IOException
mergeFrom in interface com.google.protobuf.Message.BuildermergeFrom in interface com.google.protobuf.MessageLite.BuildermergeFrom in class com.google.protobuf.AbstractMessage.Builder<Endpoint.Builder>java.io.IOExceptionpublic java.lang.String getName()
The canonical name of this endpoint.
string name = 1;getName in interface EndpointOrBuilderpublic com.google.protobuf.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(com.google.protobuf.ByteString value)
The canonical name of this endpoint.
string name = 1;@Deprecated public com.google.protobuf.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 com.google.protobuf.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(com.google.protobuf.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 com.google.protobuf.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 com.google.protobuf.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(com.google.protobuf.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 com.google.protobuf.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(com.google.protobuf.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(com.google.protobuf.UnknownFieldSet unknownFields)
setUnknownFields in interface com.google.protobuf.Message.BuildersetUnknownFields in class com.google.protobuf.GeneratedMessageV3.Builder<Endpoint.Builder>public final Endpoint.Builder mergeUnknownFields(com.google.protobuf.UnknownFieldSet unknownFields)
mergeUnknownFields in interface com.google.protobuf.Message.BuildermergeUnknownFields in class com.google.protobuf.GeneratedMessageV3.Builder<Endpoint.Builder>