public final class Endpoint extends 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:
# for service <code>library-example.googleapis.com</code>. The <code>https</code> 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
Static Fields
ALIASES_FIELD_NUMBER
public static final int ALIASES_FIELD_NUMBER
| Field Value |
|---|
| Type | Description |
int | |
ALLOW_CORS_FIELD_NUMBER
public static final int ALLOW_CORS_FIELD_NUMBER
| Field Value |
|---|
| Type | Description |
int | |
NAME_FIELD_NUMBER
public static final int NAME_FIELD_NUMBER
| Field Value |
|---|
| Type | Description |
int | |
TARGET_FIELD_NUMBER
public static final int TARGET_FIELD_NUMBER
| Field Value |
|---|
| Type | Description |
int | |
Static Methods
getDefaultInstance()
public static Endpoint getDefaultInstance()
getDescriptor()
public static final Descriptors.Descriptor getDescriptor()
newBuilder()
public static Endpoint.Builder newBuilder()
newBuilder(Endpoint prototype)
public static Endpoint.Builder newBuilder(Endpoint prototype)
| Parameter |
|---|
| Name | Description |
prototype | Endpoint
|
public static Endpoint parseDelimitedFrom(InputStream input)
public static Endpoint parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
parseFrom(byte[] data)
public static Endpoint parseFrom(byte[] data)
| Parameter |
|---|
| Name | Description |
data | byte[]
|
parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
public static Endpoint parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
parseFrom(ByteString data)
public static Endpoint parseFrom(ByteString data)
parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
public static Endpoint parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
public static Endpoint parseFrom(CodedInputStream input)
public static Endpoint parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
public static Endpoint parseFrom(InputStream input)
public static Endpoint parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
parseFrom(ByteBuffer data)
public static Endpoint parseFrom(ByteBuffer data)
parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
public static Endpoint parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
parser()
public static Parser<Endpoint> parser()
Methods
equals(Object obj)
public boolean equals(Object obj)
| Parameter |
|---|
| Name | Description |
obj | Object
|
Overrides
getAliases(int index) (deprecated)
public 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 for each
of the intended aliases.
Additional names that this endpoint will be hosted on.
repeated string aliases = 2 [deprecated = true];
| Parameter |
|---|
| Name | Description |
index | int
The index of the element to return.
|
| Returns |
|---|
| Type | Description |
String | The aliases at the given index.
|
getAliasesBytes(int index) (deprecated)
public 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 for each
of the intended aliases.
Additional names that this endpoint will be hosted on.
repeated string aliases = 2 [deprecated = true];
| Parameter |
|---|
| Name | Description |
index | int
The index of the value to return.
|
| Returns |
|---|
| Type | Description |
ByteString | The bytes of the aliases at the given index.
|
getAliasesCount() (deprecated)
public 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 for each
of the intended aliases.
Additional names that this endpoint will be hosted on.
repeated string aliases = 2 [deprecated = true];
| Returns |
|---|
| Type | Description |
int | The count of aliases.
|
getAliasesList() (deprecated)
public ProtocolStringList 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 for each
of the intended aliases.
Additional names that this endpoint will be hosted on.
repeated string aliases = 2 [deprecated = true];
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;
| Returns |
|---|
| Type | Description |
boolean | The allowCors.
|
getDefaultInstanceForType()
public Endpoint getDefaultInstanceForType()
getName()
The canonical name of this endpoint.
string name = 1;
| Returns |
|---|
| Type | Description |
String | The name.
|
getNameBytes()
public ByteString getNameBytes()
The canonical name of this endpoint.
string name = 1;
| Returns |
|---|
| Type | Description |
ByteString | The bytes for name.
|
getParserForType()
public Parser<Endpoint> getParserForType()
Overrides
getSerializedSize()
public int getSerializedSize()
| Returns |
|---|
| Type | Description |
int | |
Overrides
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;
| Returns |
|---|
| 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;
| Returns |
|---|
| Type | Description |
ByteString | The bytes for target.
|
getUnknownFields()
public final UnknownFieldSet getUnknownFields()
Overrides
hashCode()
| Returns |
|---|
| Type | Description |
int | |
Overrides
internalGetFieldAccessorTable()
protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Overrides
isInitialized()
public final boolean isInitialized()
Overrides
newBuilderForType()
public Endpoint.Builder newBuilderForType()
newBuilderForType(GeneratedMessageV3.BuilderParent parent)
protected Endpoint.Builder newBuilderForType(GeneratedMessageV3.BuilderParent parent)
Overrides
newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
protected Object newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
Overrides
toBuilder()
public Endpoint.Builder toBuilder()
writeTo(CodedOutputStream output)
public void writeTo(CodedOutputStream output)
Overrides
