Package com.google.api

Interface EndpointOrBuilder

  • All Superinterfaces:
    com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder
    All Known Implementing Classes:
    Endpoint, Endpoint.Builder
    public interface EndpointOrBuilder
extends com.google.protobuf.MessageOrBuilder

    • Method Summary

      All Methods Instance Methods Abstract Methods Deprecated Methods 
      Modifier and Type Method Description
      String getAliases​(int index)
      Deprecated.
      google.api.Endpoint.aliases is deprecated.
      com.google.protobuf.ByteString getAliasesBytes​(int index)
      Deprecated.
      google.api.Endpoint.aliases is deprecated.
      int getAliasesCount()
      Deprecated.
      google.api.Endpoint.aliases is deprecated.
      List<String> getAliasesList()
      Deprecated.
      google.api.Endpoint.aliases is 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.
      String getName()
      The canonical name of this endpoint.
      com.google.protobuf.ByteString getNameBytes()
      The canonical name of this endpoint.
      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).

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

        isInitialized

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

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

    • Method Detail

      • getName

        String getName()
         The canonical name of this endpoint.
        string name = 1;
        Returns:
        The name.

      • getNameBytes

        com.google.protobuf.ByteString getNameBytes()
         The canonical name of this endpoint.
        string name = 1;
        Returns:
        The bytes for name.

      • getAliasesList

        @Deprecated
List<String> getAliasesList()
        Deprecated.
        google.api.Endpoint.aliases is deprecated. See google/api/endpoint.proto;l=56
         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];
        Returns:
        A list containing the aliases.

      • getAliasesCount

        @Deprecated
int getAliasesCount()
        Deprecated.
        google.api.Endpoint.aliases is deprecated. See google/api/endpoint.proto;l=56
         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];
        Returns:
        The count of aliases.

      • getAliases

        @Deprecated
String getAliases​(int index)
        Deprecated.
        google.api.Endpoint.aliases is deprecated. See google/api/endpoint.proto;l=56
         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];
        Parameters:
        index - The index of the element to return.
        Returns:
        The aliases at the given index.

      • getAliasesBytes

        @Deprecated
com.google.protobuf.ByteString getAliasesBytes​(int index)
        Deprecated.
        google.api.Endpoint.aliases is deprecated. See google/api/endpoint.proto;l=56
         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];
        Parameters:
        index - The index of the value to return.
        Returns:
        The bytes of the aliases at the given index.

      • getTarget

        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;
        Returns:
        The target.

      • getTargetBytes

        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;
        Returns:
        The bytes for target.

      • getAllowCors

        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;
        Returns:
        The allowCors.