com.google.api

Class Endpoint

java.lang.Object

com.google.protobuf.AbstractMessageLite

com.google.protobuf.AbstractMessage

com.google.protobuf.GeneratedMessageV3

com.google.api.Endpoint

All Implemented Interfaces:

EndpointOrBuilder, Message, MessageLite, MessageLiteOrBuilder, MessageOrBuilder, java.io.Serializable

public final class Endpoint
extends 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: true
 

Protobuf type google.api.Endpoint

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	Endpoint.Builder `Endpoint` describes a network endpoint that serves a set of APIs.

Nested classes/interfaces inherited from class com.google.protobuf.GeneratedMessageV3

GeneratedMessageV3.BuilderParent, GeneratedMessageV3.ExtendableBuilder<MessageType extends GeneratedMessageV3.ExtendableMessage,BuilderType extends GeneratedMessageV3.ExtendableBuilder<MessageType,BuilderType>>, GeneratedMessageV3.ExtendableMessage<MessageType extends GeneratedMessageV3.ExtendableMessage>, GeneratedMessageV3.ExtendableMessageOrBuilder<MessageType extends GeneratedMessageV3.ExtendableMessage>, GeneratedMessageV3.FieldAccessorTable

Field Summary

Fields

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

Fields inherited from class com.google.protobuf.GeneratedMessageV3

alwaysUseFieldBuilders, unknownFields

Fields inherited from class com.google.protobuf.AbstractMessage

memoizedSize

Fields inherited from class com.google.protobuf.AbstractMessageLite

memoizedHashCode

Method Summary

Modifier and Type	Method and Description
boolean	equals(java.lang.Object obj)
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.
static Endpoint	getDefaultInstance()
Endpoint	getDefaultInstanceForType()
static Descriptors.Descriptor	getDescriptor()
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.
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).
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).
UnknownFieldSet	getUnknownFields()
int	hashCode()
protected GeneratedMessageV3.FieldAccessorTable	internalGetFieldAccessorTable()
boolean	isInitialized()
static Endpoint.Builder	newBuilder()
static Endpoint.Builder	newBuilder(Endpoint prototype)
Endpoint.Builder	newBuilderForType()
protected Endpoint.Builder	newBuilderForType(GeneratedMessageV3.BuilderParent parent)
static Endpoint	parseDelimitedFrom(java.io.InputStream input)
static Endpoint	parseDelimitedFrom(java.io.InputStream input, ExtensionRegistryLite extensionRegistry)
static Endpoint	parseFrom(byte[] data)
static Endpoint	parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
static Endpoint	parseFrom(java.nio.ByteBuffer data)
static Endpoint	parseFrom(java.nio.ByteBuffer data, ExtensionRegistryLite extensionRegistry)
static Endpoint	parseFrom(ByteString data)
static Endpoint	parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
static Endpoint	parseFrom(CodedInputStream input)
static Endpoint	parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
static Endpoint	parseFrom(java.io.InputStream input)
static Endpoint	parseFrom(java.io.InputStream input, ExtensionRegistryLite extensionRegistry)
static Parser<Endpoint>	parser()
Endpoint.Builder	toBuilder()
void	writeTo(CodedOutputStream output)

Methods inherited from class com.google.protobuf.GeneratedMessageV3

canUseUnsafe, computeStringSize, computeStringSizeNoTag, emptyBooleanList, emptyDoubleList, emptyFloatList, emptyIntList, emptyLongList, getAllFields, getDescriptorForType, getField, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, hasField, hasOneof, internalGetMapField, makeExtensionsImmutable, mutableCopy, mutableCopy, mutableCopy, mutableCopy, mutableCopy, newBooleanList, newBuilderForType, newDoubleList, newFloatList, newIntList, newLongList, parseDelimitedWithIOException, parseDelimitedWithIOException, parseUnknownField, parseUnknownFieldProto3, parseWithIOException, parseWithIOException, parseWithIOException, parseWithIOException, serializeBooleanMapTo, serializeIntegerMapTo, serializeLongMapTo, serializeStringMapTo, writeReplace, writeString, writeStringNoTag

Methods inherited from class com.google.protobuf.AbstractMessage

findInitializationErrors, getInitializationErrorString, hashBoolean, hashEnum, hashEnumList, hashFields, hashLong, toString

Methods inherited from class com.google.protobuf.AbstractMessageLite

addAll, addAll, checkByteStringIsUtf8, toByteArray, toByteString, writeDelimitedTo, writeTo

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface com.google.protobuf.MessageOrBuilder

findInitializationErrors, getAllFields, getDescriptorForType, getField, getInitializationErrorString, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, hasField, hasOneof

Methods inherited from interface com.google.protobuf.MessageLite

toByteArray, toByteString, writeDelimitedTo, writeTo

Field Detail

NAME_FIELD_NUMBER

public static final int NAME_FIELD_NUMBER

See Also:

Constant Field Values

ALIASES_FIELD_NUMBER

public static final int ALIASES_FIELD_NUMBER

See Also:

Constant Field Values

FEATURES_FIELD_NUMBER

public static final int FEATURES_FIELD_NUMBER

See Also:

Constant Field Values

TARGET_FIELD_NUMBER

public static final int TARGET_FIELD_NUMBER

See Also:

Constant Field Values

ALLOW_CORS_FIELD_NUMBER

public static final int ALLOW_CORS_FIELD_NUMBER

See Also:

Constant Field Values

Method Detail

getUnknownFields

public final UnknownFieldSet getUnknownFields()

Specified by:

getUnknownFields in interface MessageOrBuilder

Overrides:

getUnknownFields in class GeneratedMessageV3

getDescriptor

public static final Descriptors.Descriptor getDescriptor()

internalGetFieldAccessorTable

protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()

Specified by:

internalGetFieldAccessorTable in class GeneratedMessageV3

getName

public java.lang.String getName()

 The canonical name of this endpoint.
 

string name = 1;

Specified by:

getName in interface EndpointOrBuilder

getNameBytes

public ByteString getNameBytes()

 The canonical name of this endpoint.
 

string name = 1;

Specified by:

getNameBytes in interface EndpointOrBuilder

getAliasesList

@Deprecated
public ProtocolStringList getAliasesList()

Deprecated.

 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];

Specified by:

getAliasesList in interface EndpointOrBuilder

getAliasesCount

@Deprecated
public int getAliasesCount()

Deprecated.

 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];

Specified by:

getAliasesCount in interface EndpointOrBuilder

getAliases

@Deprecated
public java.lang.String getAliases(int index)

Deprecated.

 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];

Specified by:

getAliases in interface EndpointOrBuilder

getAliasesBytes

@Deprecated
public ByteString getAliasesBytes(int index)

Deprecated.

 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];

Specified by:

getAliasesBytes in interface EndpointOrBuilder

getFeaturesList

public ProtocolStringList getFeaturesList()

 The list of features enabled on this endpoint.
 

repeated string features = 4;

Specified by:

getFeaturesList in interface EndpointOrBuilder

getFeaturesCount

public int getFeaturesCount()

 The list of features enabled on this endpoint.
 

repeated string features = 4;

Specified by:

getFeaturesCount in interface EndpointOrBuilder

getFeatures

public java.lang.String getFeatures(int index)

 The list of features enabled on this endpoint.
 

repeated string features = 4;

Specified by:

getFeatures in interface EndpointOrBuilder

getFeaturesBytes

public ByteString getFeaturesBytes(int index)

 The list of features enabled on this endpoint.
 

repeated string features = 4;

Specified by:

getFeaturesBytes in interface EndpointOrBuilder

getTarget

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;

Specified by:

getTarget in interface EndpointOrBuilder

getTargetBytes

public 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;

Specified by:

getTargetBytes in interface EndpointOrBuilder

getAllowCors

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;

Specified by:

getAllowCors in interface EndpointOrBuilder

isInitialized

public final boolean isInitialized()

Specified by:

isInitialized in interface MessageLiteOrBuilder

Overrides:

isInitialized in class GeneratedMessageV3

writeTo

public void writeTo(CodedOutputStream output)
             throws java.io.IOException

Specified by:

writeTo in interface MessageLite

Overrides:

writeTo in class GeneratedMessageV3

Throws:

java.io.IOException

getSerializedSize

public int getSerializedSize()

Specified by:

getSerializedSize in interface MessageLite

Overrides:

getSerializedSize in class GeneratedMessageV3

equals

public boolean equals(java.lang.Object obj)

Specified by:

equals in interface Message

Overrides:

equals in class AbstractMessage

hashCode

public int hashCode()

Specified by:

hashCode in interface Message

Overrides:

hashCode in class AbstractMessage

parseFrom

public static Endpoint parseFrom(java.nio.ByteBuffer data)
                          throws InvalidProtocolBufferException

Throws:

InvalidProtocolBufferException

parseFrom

public static Endpoint parseFrom(java.nio.ByteBuffer data,
                                 ExtensionRegistryLite extensionRegistry)
                          throws InvalidProtocolBufferException

Throws:

InvalidProtocolBufferException

parseFrom

public static Endpoint parseFrom(ByteString data)
                          throws InvalidProtocolBufferException

Throws:

InvalidProtocolBufferException

parseFrom

public static Endpoint parseFrom(ByteString data,
                                 ExtensionRegistryLite extensionRegistry)
                          throws InvalidProtocolBufferException

Throws:

InvalidProtocolBufferException

parseFrom

public static Endpoint parseFrom(byte[] data)
                          throws InvalidProtocolBufferException

Throws:

InvalidProtocolBufferException

parseFrom

public static Endpoint parseFrom(byte[] data,
                                 ExtensionRegistryLite extensionRegistry)
                          throws InvalidProtocolBufferException

Throws:

InvalidProtocolBufferException

parseFrom

public static Endpoint parseFrom(java.io.InputStream input)
                          throws java.io.IOException

Throws:

java.io.IOException

parseFrom

public static Endpoint parseFrom(java.io.InputStream input,
                                 ExtensionRegistryLite extensionRegistry)
                          throws java.io.IOException

Throws:

java.io.IOException

parseDelimitedFrom

public static Endpoint parseDelimitedFrom(java.io.InputStream input)
                                   throws java.io.IOException

Throws:

java.io.IOException

parseDelimitedFrom

public static Endpoint parseDelimitedFrom(java.io.InputStream input,
                                          ExtensionRegistryLite extensionRegistry)
                                   throws java.io.IOException

Throws:

java.io.IOException

parseFrom

public static Endpoint parseFrom(CodedInputStream input)
                          throws java.io.IOException

Throws:

java.io.IOException

parseFrom

public static Endpoint parseFrom(CodedInputStream input,
                                 ExtensionRegistryLite extensionRegistry)
                          throws java.io.IOException

Throws:

java.io.IOException

newBuilderForType

public Endpoint.Builder newBuilderForType()

Specified by:

newBuilderForType in interface Message

Specified by:

newBuilderForType in interface MessageLite

newBuilder

public static Endpoint.Builder newBuilder()

newBuilder

public static Endpoint.Builder newBuilder(Endpoint prototype)

toBuilder

public Endpoint.Builder toBuilder()

Specified by:

toBuilder in interface Message

Specified by:

toBuilder in interface MessageLite

newBuilderForType

protected Endpoint.Builder newBuilderForType(GeneratedMessageV3.BuilderParent parent)

Specified by:

newBuilderForType in class GeneratedMessageV3

getDefaultInstance

public static Endpoint getDefaultInstance()

parser

public static Parser<Endpoint> parser()

getParserForType

public Parser<Endpoint> getParserForType()

Specified by:

getParserForType in interface Message

Specified by:

getParserForType in interface MessageLite

Overrides:

getParserForType in class GeneratedMessageV3

getDefaultInstanceForType

public Endpoint getDefaultInstanceForType()

Specified by:

getDefaultInstanceForType in interface MessageLiteOrBuilder

Specified by:

getDefaultInstanceForType in interface MessageOrBuilder