Package com.google.api

Class Endpoint

  • All Implemented Interfaces:
    EndpointOrBuilder, com.google.protobuf.GeneratedMessage.ExtendableMessageOrBuilder<com.google.protobuf.GeneratedMessageV3>, com.google.protobuf.Message, com.google.protobuf.MessageLite, com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder, java.io.Serializable
    public final class Endpoint
extends com.google.protobuf.GeneratedMessageV3
implements EndpointOrBuilder
     `Endpoint` describes a network address 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:

     type: google.api.Service
     name: library-example.googleapis.com
     endpoints:
       # Declares network address `https://library-example.googleapis.com`
       # for service `library-example.googleapis.com`. The `https` scheme
       # is implicit for all service endpoints. Other schemes may be
       # supported in the future.
     - name: library-example.googleapis.com
       allow_cors: false
     - name: content-staging-library-example.googleapis.com
       # Allows HTTP OPTIONS calls to be passed to the API frontend, for it
       # to decide whether the subsequent cross-origin request is allowed
       # to proceed.
       allow_cors: true
    Protobuf type google.api.Endpoint
    See Also:
    Serialized Form

    • Nested Class Summary

      Nested Classes 
      Modifier and Type Class Description
      static class  Endpoint.Builder
      `Endpoint` describes a network address 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<MessageT extends com.google.protobuf.GeneratedMessageV3.ExtendableMessage<MessageT>,​BuilderT extends com.google.protobuf.GeneratedMessageV3.ExtendableBuilder<MessageT,​BuilderT>>, com.google.protobuf.GeneratedMessageV3.ExtendableMessage<MessageT extends com.google.protobuf.GeneratedMessageV3.ExtendableMessage<MessageT>>, com.google.protobuf.GeneratedMessageV3.ExtendableMessageOrBuilder<MessageT extends com.google.protobuf.GeneratedMessageV3.ExtendableMessage<MessageT>>, com.google.protobuf.GeneratedMessageV3.FieldAccessorTable, com.google.protobuf.GeneratedMessageV3.UnusedPrivateParameter

      • Nested classes/interfaces inherited from class com.google.protobuf.GeneratedMessage.ExtendableMessage

        com.google.protobuf.GeneratedMessage.ExtendableMessage.ExtensionSerializer, com.google.protobuf.GeneratedMessage.ExtendableMessage.ExtensionWriter

      • Nested classes/interfaces inherited from class com.google.protobuf.GeneratedMessage

        com.google.protobuf.GeneratedMessage.GeneratedExtension<ContainingT extends com.google.protobuf.Message,​T extends java.lang.Object>

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

        com.google.protobuf.AbstractMessageLite.InternalOneOfEnum

    • Field Summary

      Fields 
      Modifier and Type Field 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.GeneratedMessage

        alwaysUseFieldBuilders, unknownFields

      • Fields inherited from class com.google.protobuf.AbstractMessage

        memoizedSize

      • Fields inherited from class com.google.protobuf.AbstractMessageLite

        memoizedHashCode

    • Method Summary

      All Methods Static Methods Instance Methods Concrete Methods 
      Modifier and Type Method Description
      boolean equals​(java.lang.Object obj)  
      java.lang.String getAliases​(int index)
      Aliases for this endpoint, these will be served by the same UrlMap as the parent endpoint, and will be provisioned in the GCP stack for the Regional Endpoints.
      com.google.protobuf.ByteString getAliasesBytes​(int index)
      Aliases for this endpoint, these will be served by the same UrlMap as the parent endpoint, and will be provisioned in the GCP stack for the Regional Endpoints.
      int getAliasesCount()
      Aliases for this endpoint, these will be served by the same UrlMap as the parent endpoint, and will be provisioned in the GCP stack for the Regional Endpoints.
      com.google.protobuf.ProtocolStringList getAliasesList()
      Aliases for this endpoint, these will be served by the same UrlMap as the parent endpoint, and will be provisioned in the GCP stack for the Regional Endpoints.
      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 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).
      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 java.lang.Object newInstance​(com.google.protobuf.GeneratedMessageV3.UnusedPrivateParameter unused)  
      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​(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 Endpoint parseFrom​(java.nio.ByteBuffer data)  
      static Endpoint parseFrom​(java.nio.ByteBuffer data, 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

        mutableCopy, mutableCopy, mutableCopy, mutableCopy, mutableCopy, newBuilderForType

      • Methods inherited from class com.google.protobuf.GeneratedMessage.ExtendableMessage

        extensionsAreInitialized, extensionsSerializedSize, extensionsSerializedSizeAsMessageSet, getAllFields, getAllFieldsRaw, getExtension, getExtension, getExtensionCount, getExtensionFields, getField, getRepeatedField, getRepeatedFieldCount, hasExtension, hasField, newExtensionSerializer, newExtensionWriter, newMessageSetExtensionSerializer, newMessageSetExtensionWriter

      • Methods inherited from class com.google.protobuf.GeneratedMessage

        canUseUnsafe, computeStringSize, computeStringSizeNoTag, emptyBooleanList, emptyDoubleList, emptyFloatList, emptyIntList, emptyList, emptyLongList, getDescriptorForType, getOneofFieldDescriptor, getUnknownFields, hasOneof, internalGetMapField, internalGetMapFieldReflection, isStringEmpty, makeMutableCopy, makeMutableCopy, mergeFromAndMakeImmutableInternal, newFileScopedGeneratedExtension, newInstance, newMessageScopedGeneratedExtension, 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, hashFields, toString

      • Methods inherited from class com.google.protobuf.AbstractMessageLite

        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.MessageLite

        toByteArray, toByteString, writeDelimitedTo, writeTo

      • Methods inherited from interface com.google.protobuf.MessageOrBuilder

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

    • Method Detail

      • newInstance

        protected java.lang.Object newInstance​(com.google.protobuf.GeneratedMessageV3.UnusedPrivateParameter unused)
        Overrides:
        newInstance in class com.google.protobuf.GeneratedMessageV3

      • getDescriptor

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

      • internalGetFieldAccessorTable

        protected com.google.protobuf.GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
        Overrides:
        internalGetFieldAccessorTable in class com.google.protobuf.GeneratedMessageV3

      • getName

        public java.lang.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

        public com.google.protobuf.ProtocolStringList getAliasesList()
         Aliases for this endpoint, these will be served by the same UrlMap as the
 parent endpoint, and will be provisioned in the GCP stack for the Regional
 Endpoints.
        repeated string aliases = 2;
        Specified by:
        getAliasesList in interface EndpointOrBuilder
        Returns:
        A list containing the aliases.

      • getAliasesCount

        public int getAliasesCount()
         Aliases for this endpoint, these will be served by the same UrlMap as the
 parent endpoint, and will be provisioned in the GCP stack for the Regional
 Endpoints.
        repeated string aliases = 2;
        Specified by:
        getAliasesCount in interface EndpointOrBuilder
        Returns:
        The count of aliases.

      • getAliases

        public java.lang.String getAliases​(int index)
         Aliases for this endpoint, these will be served by the same UrlMap as the
 parent endpoint, and will be provisioned in the GCP stack for the Regional
 Endpoints.
        repeated string aliases = 2;
        Specified by:
        getAliases in interface EndpointOrBuilder
        Parameters:
        index - The index of the element to return.
        Returns:
        The aliases at the given index.

      • getAliasesBytes

        public com.google.protobuf.ByteString getAliasesBytes​(int index)
         Aliases for this endpoint, these will be served by the same UrlMap as the
 parent endpoint, and will be provisioned in the GCP stack for the Regional
 Endpoints.
        repeated string aliases = 2;
        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 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
        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.GeneratedMessage.ExtendableMessage<com.google.protobuf.GeneratedMessageV3>

      • writeTo

        public void writeTo​(com.google.protobuf.CodedOutputStream output)
             throws java.io.IOException
        Specified by:
        writeTo in interface com.google.protobuf.MessageLite
        Overrides:
        writeTo in class com.google.protobuf.GeneratedMessage
        Throws:
        java.io.IOException

      • getSerializedSize

        public int getSerializedSize()
        Specified by:
        getSerializedSize in interface com.google.protobuf.MessageLite
        Overrides:
        getSerializedSize in class com.google.protobuf.GeneratedMessage

      • equals

        public boolean equals​(java.lang.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​(java.nio.ByteBuffer data)
                          throws com.google.protobuf.InvalidProtocolBufferException
        Throws:
        com.google.protobuf.InvalidProtocolBufferException

      • parseFrom

        public static Endpoint parseFrom​(java.nio.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​(java.io.InputStream input)
                          throws java.io.IOException
        Throws:
        java.io.IOException

      • parseFrom

        public static Endpoint parseFrom​(java.io.InputStream input,
                                 com.google.protobuf.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,
                                          com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                                   throws java.io.IOException
        Throws:
        java.io.IOException

      • parseFrom

        public static Endpoint parseFrom​(com.google.protobuf.CodedInputStream input)
                          throws java.io.IOException
        Throws:
        java.io.IOException

      • parseFrom

        public static Endpoint parseFrom​(com.google.protobuf.CodedInputStream input,
                                 com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                          throws java.io.IOException
        Throws:
        java.io.IOException

      • newBuilderForType

        public Endpoint.Builder newBuilderForType()
        Specified by:
        newBuilderForType in interface com.google.protobuf.Message
        Specified by:
        newBuilderForType in interface com.google.protobuf.MessageLite

      • 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.GeneratedMessage

      • getDefaultInstanceForType

        public Endpoint getDefaultInstanceForType()
        Specified by:
        getDefaultInstanceForType in interface com.google.protobuf.GeneratedMessage.ExtendableMessageOrBuilder<com.google.protobuf.GeneratedMessageV3>
        Specified by:
        getDefaultInstanceForType in interface com.google.protobuf.MessageLiteOrBuilder
        Specified by:
        getDefaultInstanceForType in interface com.google.protobuf.MessageOrBuilder