public final class Endpoint extends com.google.protobuf.GeneratedMessageV3 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: trueProtobuf type
google.api.Endpoint
Modifier and Type | Class and Description |
---|---|
static class |
Endpoint.Builder
`Endpoint` describes a network endpoint that serves a set of APIs.
|
com.google.protobuf.GeneratedMessageV3.BuilderParent, com.google.protobuf.GeneratedMessageV3.ExtendableBuilder<MessageType extends com.google.protobuf.GeneratedMessageV3.ExtendableMessage,BuilderType extends com.google.protobuf.GeneratedMessageV3.ExtendableBuilder<MessageType,BuilderType>>, com.google.protobuf.GeneratedMessageV3.ExtendableMessage<MessageType extends com.google.protobuf.GeneratedMessageV3.ExtendableMessage>, com.google.protobuf.GeneratedMessageV3.ExtendableMessageOrBuilder<MessageType extends com.google.protobuf.GeneratedMessageV3.ExtendableMessage>, com.google.protobuf.GeneratedMessageV3.FieldAccessorTable
Modifier and Type | Field and Description |
---|---|
static int |
ALIASES_FIELD_NUMBER |
static int |
ALLOW_CORS_FIELD_NUMBER |
static int |
FEATURES_FIELD_NUMBER |
static int |
NAME_FIELD_NUMBER |
static int |
TARGET_FIELD_NUMBER |
Modifier and Type | Method and Description |
---|---|
boolean |
equals(java.lang.Object obj) |
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.
|
static Endpoint |
getDefaultInstance() |
Endpoint |
getDefaultInstanceForType() |
static com.google.protobuf.Descriptors.Descriptor |
getDescriptor() |
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.
|
com.google.protobuf.Parser<Endpoint> |
getParserForType() |
int |
getSerializedSize() |
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).
|
com.google.protobuf.UnknownFieldSet |
getUnknownFields() |
int |
hashCode() |
protected com.google.protobuf.GeneratedMessageV3.FieldAccessorTable |
internalGetFieldAccessorTable() |
boolean |
isInitialized() |
static Endpoint.Builder |
newBuilder() |
static Endpoint.Builder |
newBuilder(Endpoint prototype) |
Endpoint.Builder |
newBuilderForType() |
protected Endpoint.Builder |
newBuilderForType(com.google.protobuf.GeneratedMessageV3.BuilderParent parent) |
static Endpoint |
parseDelimitedFrom(java.io.InputStream input) |
static Endpoint |
parseDelimitedFrom(java.io.InputStream input,
com.google.protobuf.ExtensionRegistryLite extensionRegistry) |
static Endpoint |
parseFrom(byte[] data) |
static Endpoint |
parseFrom(byte[] data,
com.google.protobuf.ExtensionRegistryLite extensionRegistry) |
static Endpoint |
parseFrom(java.nio.ByteBuffer data) |
static Endpoint |
parseFrom(java.nio.ByteBuffer data,
com.google.protobuf.ExtensionRegistryLite extensionRegistry) |
static Endpoint |
parseFrom(com.google.protobuf.ByteString data) |
static Endpoint |
parseFrom(com.google.protobuf.ByteString data,
com.google.protobuf.ExtensionRegistryLite extensionRegistry) |
static Endpoint |
parseFrom(com.google.protobuf.CodedInputStream input) |
static Endpoint |
parseFrom(com.google.protobuf.CodedInputStream input,
com.google.protobuf.ExtensionRegistryLite extensionRegistry) |
static Endpoint |
parseFrom(java.io.InputStream input) |
static Endpoint |
parseFrom(java.io.InputStream input,
com.google.protobuf.ExtensionRegistryLite extensionRegistry) |
static com.google.protobuf.Parser<Endpoint> |
parser() |
Endpoint.Builder |
toBuilder() |
void |
writeTo(com.google.protobuf.CodedOutputStream output) |
canUseUnsafe, computeStringSize, computeStringSizeNoTag, getAllFields, getDescriptorForType, getField, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, hasField, hasOneof, internalGetMapField, makeExtensionsImmutable, newBuilderForType, parseDelimitedWithIOException, parseDelimitedWithIOException, parseUnknownField, parseUnknownFieldProto3, parseWithIOException, parseWithIOException, parseWithIOException, parseWithIOException, serializeBooleanMapTo, serializeIntegerMapTo, serializeLongMapTo, serializeStringMapTo, writeReplace, writeString, writeStringNoTag
findInitializationErrors, getInitializationErrorString, hashBoolean, hashEnum, hashEnumList, hashFields, hashLong, toString
addAll, addAll, checkByteStringIsUtf8, toByteArray, toByteString, writeDelimitedTo, writeTo
clone, finalize, getClass, notify, notifyAll, wait, wait, wait
public static final int NAME_FIELD_NUMBER
public static final int ALIASES_FIELD_NUMBER
public static final int FEATURES_FIELD_NUMBER
public static final int TARGET_FIELD_NUMBER
public static final int ALLOW_CORS_FIELD_NUMBER
public final com.google.protobuf.UnknownFieldSet getUnknownFields()
getUnknownFields
in interface com.google.protobuf.MessageOrBuilder
getUnknownFields
in class com.google.protobuf.GeneratedMessageV3
public static final com.google.protobuf.Descriptors.Descriptor getDescriptor()
protected com.google.protobuf.GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
internalGetFieldAccessorTable
in class com.google.protobuf.GeneratedMessageV3
public java.lang.String getName()
The canonical name of this endpoint.
string name = 1;
getName
in interface EndpointOrBuilder
public com.google.protobuf.ByteString getNameBytes()
The canonical name of this endpoint.
string name = 1;
getNameBytes
in interface EndpointOrBuilder
@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
public com.google.protobuf.ProtocolStringList getFeaturesList()
The list of features enabled on this endpoint.
repeated string features = 4;
getFeaturesList
in interface EndpointOrBuilder
public int getFeaturesCount()
The list of features enabled on this endpoint.
repeated string features = 4;
getFeaturesCount
in interface EndpointOrBuilder
public java.lang.String getFeatures(int index)
The list of features enabled on this endpoint.
repeated string features = 4;
getFeatures
in interface EndpointOrBuilder
public com.google.protobuf.ByteString getFeaturesBytes(int index)
The list of features enabled on this endpoint.
repeated string features = 4;
getFeaturesBytes
in interface EndpointOrBuilder
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 EndpointOrBuilder
public 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 EndpointOrBuilder
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 EndpointOrBuilder
public final boolean isInitialized()
isInitialized
in interface com.google.protobuf.MessageLiteOrBuilder
isInitialized
in class com.google.protobuf.GeneratedMessageV3
public void writeTo(com.google.protobuf.CodedOutputStream output) throws java.io.IOException
writeTo
in interface com.google.protobuf.MessageLite
writeTo
in class com.google.protobuf.GeneratedMessageV3
java.io.IOException
public int getSerializedSize()
getSerializedSize
in interface com.google.protobuf.MessageLite
getSerializedSize
in class com.google.protobuf.GeneratedMessageV3
public boolean equals(java.lang.Object obj)
equals
in interface com.google.protobuf.Message
equals
in class com.google.protobuf.AbstractMessage
public int hashCode()
hashCode
in interface com.google.protobuf.Message
hashCode
in class com.google.protobuf.AbstractMessage
public static Endpoint parseFrom(java.nio.ByteBuffer data) throws com.google.protobuf.InvalidProtocolBufferException
com.google.protobuf.InvalidProtocolBufferException
public static Endpoint parseFrom(java.nio.ByteBuffer data, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws com.google.protobuf.InvalidProtocolBufferException
com.google.protobuf.InvalidProtocolBufferException
public static Endpoint parseFrom(com.google.protobuf.ByteString data) throws com.google.protobuf.InvalidProtocolBufferException
com.google.protobuf.InvalidProtocolBufferException
public static Endpoint parseFrom(com.google.protobuf.ByteString data, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws com.google.protobuf.InvalidProtocolBufferException
com.google.protobuf.InvalidProtocolBufferException
public static Endpoint parseFrom(byte[] data) throws com.google.protobuf.InvalidProtocolBufferException
com.google.protobuf.InvalidProtocolBufferException
public static Endpoint parseFrom(byte[] data, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws com.google.protobuf.InvalidProtocolBufferException
com.google.protobuf.InvalidProtocolBufferException
public static Endpoint parseFrom(java.io.InputStream input) throws java.io.IOException
java.io.IOException
public static Endpoint parseFrom(java.io.InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws java.io.IOException
java.io.IOException
public static Endpoint parseDelimitedFrom(java.io.InputStream input) throws java.io.IOException
java.io.IOException
public static Endpoint parseDelimitedFrom(java.io.InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws java.io.IOException
java.io.IOException
public static Endpoint parseFrom(com.google.protobuf.CodedInputStream input) throws java.io.IOException
java.io.IOException
public static Endpoint parseFrom(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws java.io.IOException
java.io.IOException
public Endpoint.Builder newBuilderForType()
newBuilderForType
in interface com.google.protobuf.Message
newBuilderForType
in interface com.google.protobuf.MessageLite
public static Endpoint.Builder newBuilder()
public static Endpoint.Builder newBuilder(Endpoint prototype)
public Endpoint.Builder toBuilder()
toBuilder
in interface com.google.protobuf.Message
toBuilder
in interface com.google.protobuf.MessageLite
protected Endpoint.Builder newBuilderForType(com.google.protobuf.GeneratedMessageV3.BuilderParent parent)
newBuilderForType
in class com.google.protobuf.GeneratedMessageV3
public static Endpoint getDefaultInstance()
public static com.google.protobuf.Parser<Endpoint> parser()
public com.google.protobuf.Parser<Endpoint> getParserForType()
getParserForType
in interface com.google.protobuf.Message
getParserForType
in interface com.google.protobuf.MessageLite
getParserForType
in class com.google.protobuf.GeneratedMessageV3
public Endpoint getDefaultInstanceForType()
getDefaultInstanceForType
in interface com.google.protobuf.MessageLiteOrBuilder
getDefaultInstanceForType
in interface com.google.protobuf.MessageOrBuilder