public final class Endpoint extends 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
Inheritance
Object > AbstractMessageLite<MessageType,BuilderType> > AbstractMessage > GeneratedMessageV3 > EndpointImplements
EndpointOrBuilderStatic Fields
ALIASES_FIELD_NUMBER
public static final int ALIASES_FIELD_NUMBER| Type | Description |
| int |
ALLOW_CORS_FIELD_NUMBER
public static final int ALLOW_CORS_FIELD_NUMBER| Type | Description |
| int |
NAME_FIELD_NUMBER
public static final int NAME_FIELD_NUMBER| Type | Description |
| int |
TARGET_FIELD_NUMBER
public static final int TARGET_FIELD_NUMBER| Type | Description |
| int |
Static Methods
getDefaultInstance()
public static Endpoint getDefaultInstance()| Type | Description |
| Endpoint |
getDescriptor()
public static final Descriptors.Descriptor getDescriptor()| Type | Description |
| Descriptor |
newBuilder()
public static Endpoint.Builder newBuilder()| Type | Description |
| Endpoint.Builder |
newBuilder(Endpoint prototype)
public static Endpoint.Builder newBuilder(Endpoint prototype)| Name | Description |
| prototype | Endpoint |
| Type | Description |
| Endpoint.Builder |
parseDelimitedFrom(InputStream input)
public static Endpoint parseDelimitedFrom(InputStream input)| Name | Description |
| input | InputStream |
| Type | Description |
| Endpoint |
| Type | Description |
| IOException |
parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
public static Endpoint parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)| Name | Description |
| input | InputStream |
| extensionRegistry | ExtensionRegistryLite |
| Type | Description |
| Endpoint |
| Type | Description |
| IOException |
parseFrom(byte[] data)
public static Endpoint parseFrom(byte[] data)| Name | Description |
| data | byte[] |
| Type | Description |
| Endpoint |
| Type | Description |
| InvalidProtocolBufferException |
parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
public static Endpoint parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)| Name | Description |
| data | byte[] |
| extensionRegistry | ExtensionRegistryLite |
| Type | Description |
| Endpoint |
| Type | Description |
| InvalidProtocolBufferException |
parseFrom(ByteString data)
public static Endpoint parseFrom(ByteString data)| Name | Description |
| data | ByteString |
| Type | Description |
| Endpoint |
| Type | Description |
| InvalidProtocolBufferException |
parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
public static Endpoint parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)| Name | Description |
| data | ByteString |
| extensionRegistry | ExtensionRegistryLite |
| Type | Description |
| Endpoint |
| Type | Description |
| InvalidProtocolBufferException |
parseFrom(CodedInputStream input)
public static Endpoint parseFrom(CodedInputStream input)| Name | Description |
| input | CodedInputStream |
| Type | Description |
| Endpoint |
| Type | Description |
| IOException |
parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
public static Endpoint parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)| Name | Description |
| input | CodedInputStream |
| extensionRegistry | ExtensionRegistryLite |
| Type | Description |
| Endpoint |
| Type | Description |
| IOException |
parseFrom(InputStream input)
public static Endpoint parseFrom(InputStream input)| Name | Description |
| input | InputStream |
| Type | Description |
| Endpoint |
| Type | Description |
| IOException |
parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
public static Endpoint parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)| Name | Description |
| input | InputStream |
| extensionRegistry | ExtensionRegistryLite |
| Type | Description |
| Endpoint |
| Type | Description |
| IOException |
parseFrom(ByteBuffer data)
public static Endpoint parseFrom(ByteBuffer data)| Name | Description |
| data | ByteBuffer |
| Type | Description |
| Endpoint |
| Type | Description |
| InvalidProtocolBufferException |
parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
public static Endpoint parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)| Name | Description |
| data | ByteBuffer |
| extensionRegistry | ExtensionRegistryLite |
| Type | Description |
| Endpoint |
| Type | Description |
| InvalidProtocolBufferException |
parser()
public static Parser<Endpoint> parser()| Type | Description |
| Parser<Endpoint> |
Methods
equals(Object obj)
public boolean equals(Object obj)| Name | Description |
| obj | Object |
| Type | Description |
| boolean |
getAliases(int index) (deprecated)
public String getAliases(int index)Deprecated.
Unimplemented. Dot not use. DEPRECATED: This field is no longer supported. Instead of using aliases, please specify multiple google.api.Endpoint for each of the intended aliases. Additional names that this endpoint will be hosted on.
repeated string aliases = 2 [deprecated = true];
| Name | Description |
| index | intThe index of the element to return. |
| Type | Description |
| String | The aliases at the given index. |
getAliasesBytes(int index) (deprecated)
public ByteString getAliasesBytes(int index)Deprecated.
Unimplemented. Dot not use. DEPRECATED: This field is no longer supported. Instead of using aliases, please specify multiple google.api.Endpoint for each of the intended aliases. Additional names that this endpoint will be hosted on.
repeated string aliases = 2 [deprecated = true];
| Name | Description |
| index | intThe index of the value to return. |
| Type | Description |
| ByteString | The bytes of the aliases at the given index. |
getAliasesCount() (deprecated)
public int getAliasesCount()Deprecated.
Unimplemented. Dot not use. DEPRECATED: This field is no longer supported. Instead of using aliases, please specify multiple google.api.Endpoint for each of the intended aliases. Additional names that this endpoint will be hosted on.
repeated string aliases = 2 [deprecated = true];
| Type | Description |
| int | The count of aliases. |
getAliasesList() (deprecated)
public ProtocolStringList getAliasesList()Deprecated.
Unimplemented. Dot not use. DEPRECATED: This field is no longer supported. Instead of using aliases, please specify multiple google.api.Endpoint for each of the intended aliases. Additional names that this endpoint will be hosted on.
repeated string aliases = 2 [deprecated = true];
| Type | Description |
| ProtocolStringList | A list containing the aliases. |
getAllowCors()
public boolean getAllowCors()Allowing CORS, 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;
| Type | Description |
| boolean | The allowCors. |
getDefaultInstanceForType()
public Endpoint getDefaultInstanceForType()| Type | Description |
| Endpoint |
getName()
public String getName()The canonical name of this endpoint.
string name = 1;
| Type | Description |
| String | The name. |
getNameBytes()
public ByteString getNameBytes()The canonical name of this endpoint.
string name = 1;
| Type | Description |
| ByteString | The bytes for name. |
getParserForType()
public Parser<Endpoint> getParserForType()| Type | Description |
| Parser<Endpoint> |
getSerializedSize()
public int getSerializedSize()| Type | Description |
| int |
getTarget()
public String getTarget()The specification of an Internet routable address of API frontend that will handle requests to this API Endpoint. 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;
| Type | Description |
| String | The target. |
getTargetBytes()
public ByteString getTargetBytes()The specification of an Internet routable address of API frontend that will handle requests to this API Endpoint. 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;
| Type | Description |
| ByteString | The bytes for target. |
getUnknownFields()
public final UnknownFieldSet getUnknownFields()| Type | Description |
| UnknownFieldSet |
hashCode()
public int hashCode()| Type | Description |
| int |
internalGetFieldAccessorTable()
protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()| Type | Description |
| FieldAccessorTable |
isInitialized()
public final boolean isInitialized()| Type | Description |
| boolean |
newBuilderForType()
public Endpoint.Builder newBuilderForType()| Type | Description |
| Endpoint.Builder |
newBuilderForType(GeneratedMessageV3.BuilderParent parent)
protected Endpoint.Builder newBuilderForType(GeneratedMessageV3.BuilderParent parent)| Name | Description |
| parent | BuilderParent |
| Type | Description |
| Endpoint.Builder |
newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
protected Object newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)| Name | Description |
| unused | UnusedPrivateParameter |
| Type | Description |
| Object |
toBuilder()
public Endpoint.Builder toBuilder()| Type | Description |
| Endpoint.Builder |
writeTo(CodedOutputStream output)
public void writeTo(CodedOutputStream output)| Name | Description |
| output | CodedOutputStream |
| Type | Description |
| IOException |