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, com.google.protobuf.Message, com.google.protobuf.MessageLite, com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder, Serializable

public final class Endpoint
extends com.google.protobuf.GeneratedMessageV3
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

See Also:

Serialized Form

Nested Class Summary

Nested Classes

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

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

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, com.google.protobuf.GeneratedMessageV3.UnusedPrivateParameter

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

com.google.protobuf.AbstractMessageLite.InternalOneOfEnum

Field Summary

Fields

Modifier and Type	Field and Description
static int	ALIASES_FIELD_NUMBER
static int	ALLOW_CORS_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(Object obj)
String	getAliases(int index) Deprecated. google.api.Endpoint.aliases is deprecated. See google/api/endpoint.proto;l=51
com.google.protobuf.ByteString	getAliasesBytes(int index) Deprecated. google.api.Endpoint.aliases is deprecated. See google/api/endpoint.proto;l=51
int	getAliasesCount() Deprecated. google.api.Endpoint.aliases is deprecated. See google/api/endpoint.proto;l=51
com.google.protobuf.ProtocolStringList	getAliasesList() Deprecated. google.api.Endpoint.aliases is deprecated. See google/api/endpoint.proto;l=51
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()
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()
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)
protected Object	newInstance(com.google.protobuf.GeneratedMessageV3.UnusedPrivateParameter unused)
static Endpoint	parseDelimitedFrom(InputStream input)
static Endpoint	parseDelimitedFrom(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(ByteBuffer data)
static Endpoint	parseFrom(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(InputStream input)
static Endpoint	parseFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static com.google.protobuf.Parser<Endpoint>	parser()
Endpoint.Builder	toBuilder()
void	writeTo(com.google.protobuf.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, isStringEmpty, makeExtensionsImmutable, mergeFromAndMakeImmutableInternal, 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

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

newInstance

protected Object newInstance(com.google.protobuf.GeneratedMessageV3.UnusedPrivateParameter unused)

Overrides:

newInstance in class com.google.protobuf.GeneratedMessageV3

getUnknownFields

public final com.google.protobuf.UnknownFieldSet getUnknownFields()

Specified by:

getUnknownFields in interface com.google.protobuf.MessageOrBuilder

Overrides:

getUnknownFields in class com.google.protobuf.GeneratedMessageV3

getDescriptor

public static final com.google.protobuf.Descriptors.Descriptor getDescriptor()

internalGetFieldAccessorTable

protected com.google.protobuf.GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()

Specified by:

internalGetFieldAccessorTable in class com.google.protobuf.GeneratedMessageV3

getName

public String getName()

 The canonical name of this endpoint.
 

string name = 1;

Specified by:

getName in interface EndpointOrBuilder

Returns:

The name.

getNameBytes

public com.google.protobuf.ByteString getNameBytes()

 The canonical name of this endpoint.
 

string name = 1;

Specified by:

getNameBytes in interface EndpointOrBuilder

Returns:

The bytes for name.

getAliasesList

@Deprecated
public com.google.protobuf.ProtocolStringList getAliasesList()

Deprecated. google.api.Endpoint.aliases is deprecated. See google/api/endpoint.proto;l=51

 Unimplemented. Dot not use.
 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

Returns:

A list containing the aliases.

getAliasesCount

@Deprecated
public int getAliasesCount()

Deprecated. google.api.Endpoint.aliases is deprecated. See google/api/endpoint.proto;l=51

 Unimplemented. Dot not use.
 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

Returns:

The count of aliases.

getAliases

@Deprecated
public String getAliases(int index)

Deprecated. google.api.Endpoint.aliases is deprecated. See google/api/endpoint.proto;l=51

 Unimplemented. Dot not use.
 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

Parameters:

index - The index of the element to return.

Returns:

The aliases at the given index.

getAliasesBytes

@Deprecated
public com.google.protobuf.ByteString getAliasesBytes(int index)

Deprecated. google.api.Endpoint.aliases is deprecated. See google/api/endpoint.proto;l=51

 Unimplemented. Dot not use.
 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

Parameters:

index - The index of the value to return.

Returns:

The bytes of the aliases at the given index.

getTarget

public 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

Returns:

The target.

getTargetBytes

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;

Specified by:

getTargetBytes in interface EndpointOrBuilder

Returns:

The bytes for target.

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

Returns:

The allowCors.

isInitialized

public final boolean isInitialized()

Specified by:

isInitialized in interface com.google.protobuf.MessageLiteOrBuilder

Overrides:

isInitialized in class com.google.protobuf.GeneratedMessageV3

writeTo

public void writeTo(com.google.protobuf.CodedOutputStream output)
             throws IOException

Specified by:

writeTo in interface com.google.protobuf.MessageLite

Overrides:

writeTo in class com.google.protobuf.GeneratedMessageV3

Throws:

IOException

getSerializedSize

public int getSerializedSize()

Specified by:

getSerializedSize in interface com.google.protobuf.MessageLite

Overrides:

getSerializedSize in class com.google.protobuf.GeneratedMessageV3

equals

public boolean equals(Object obj)

Specified by:

equals in interface com.google.protobuf.Message

Overrides:

equals in class com.google.protobuf.AbstractMessage

hashCode

public int hashCode()

Specified by:

hashCode in interface com.google.protobuf.Message

Overrides:

hashCode in class com.google.protobuf.AbstractMessage

parseFrom

public static Endpoint parseFrom(ByteBuffer data)
                          throws com.google.protobuf.InvalidProtocolBufferException

Throws:

com.google.protobuf.InvalidProtocolBufferException

parseFrom

public static Endpoint parseFrom(ByteBuffer data,
                                 com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                          throws com.google.protobuf.InvalidProtocolBufferException

Throws:

com.google.protobuf.InvalidProtocolBufferException

parseFrom

public static Endpoint parseFrom(com.google.protobuf.ByteString data)
                          throws com.google.protobuf.InvalidProtocolBufferException

Throws:

com.google.protobuf.InvalidProtocolBufferException

parseFrom

public static Endpoint parseFrom(com.google.protobuf.ByteString data,
                                 com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                          throws com.google.protobuf.InvalidProtocolBufferException

Throws:

com.google.protobuf.InvalidProtocolBufferException

parseFrom

public static Endpoint parseFrom(byte[] data)
                          throws com.google.protobuf.InvalidProtocolBufferException

Throws:

com.google.protobuf.InvalidProtocolBufferException

parseFrom

public static Endpoint parseFrom(byte[] data,
                                 com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                          throws com.google.protobuf.InvalidProtocolBufferException

Throws:

com.google.protobuf.InvalidProtocolBufferException

parseFrom

public static Endpoint parseFrom(InputStream input)
                          throws IOException

Throws:

IOException

parseFrom

public static Endpoint parseFrom(InputStream input,
                                 com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                          throws IOException

Throws:

IOException

parseDelimitedFrom

public static Endpoint parseDelimitedFrom(InputStream input)
                                   throws IOException

Throws:

IOException

parseDelimitedFrom

public static Endpoint parseDelimitedFrom(InputStream input,
                                          com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                                   throws IOException

Throws:

IOException

parseFrom

public static Endpoint parseFrom(com.google.protobuf.CodedInputStream input)
                          throws IOException

Throws:

IOException

parseFrom

public static Endpoint parseFrom(com.google.protobuf.CodedInputStream input,
                                 com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                          throws IOException

Throws:

IOException

newBuilderForType

public Endpoint.Builder newBuilderForType()

Specified by:

newBuilderForType in interface com.google.protobuf.Message

Specified by:

newBuilderForType in interface com.google.protobuf.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 com.google.protobuf.Message

Specified by:

toBuilder in interface com.google.protobuf.MessageLite

newBuilderForType

protected Endpoint.Builder newBuilderForType(com.google.protobuf.GeneratedMessageV3.BuilderParent parent)

Specified by:

newBuilderForType in class com.google.protobuf.GeneratedMessageV3

getDefaultInstance

public static Endpoint getDefaultInstance()

parser

public static com.google.protobuf.Parser<Endpoint> parser()

getParserForType

public com.google.protobuf.Parser<Endpoint> getParserForType()

Specified by:

getParserForType in interface com.google.protobuf.Message

Specified by:

getParserForType in interface com.google.protobuf.MessageLite

Overrides:

getParserForType in class com.google.protobuf.GeneratedMessageV3

getDefaultInstanceForType

public Endpoint getDefaultInstanceForType()

Specified by:

getDefaultInstanceForType in interface com.google.protobuf.MessageLiteOrBuilder

Specified by:

getDefaultInstanceForType in interface com.google.protobuf.MessageOrBuilder