Service Directory v1 API - Class Endpoint (2.3.0)

public sealed class Endpoint : IMessage<Endpoint>, IEquatable<Endpoint>, IDeepCloneable<Endpoint>, IBufferMessage, IMessage

Reference documentation and code samples for the Service Directory v1 API class Endpoint.

An individual endpoint that provides a [service][google.cloud.servicedirectory.v1.Service]. The service must already exist to create an endpoint.

Inheritance

object > Endpoint

Namespace

Google.Cloud.ServiceDirectory.V1

Assembly

Google.Cloud.ServiceDirectory.V1.dll

Constructors

Endpoint()

public Endpoint()

Endpoint(Endpoint)

public Endpoint(Endpoint other)
Parameter
NameDescription
otherEndpoint

Properties

Address

public string Address { get; set; }

Optional. An IPv4 or IPv6 address. Service Directory rejects bad addresses like:

  • 8.8.8
  • 8.8.8.8:53
  • test:bad:address
  • [::1]
  • [::1]:8080

Limited to 45 characters.

Property Value
TypeDescription
string

Annotations

public MapField<string, string> Annotations { get; }

Optional. Annotations for the endpoint. This data can be consumed by service clients.

Restrictions:

  • The entire annotations dictionary may contain up to 512 characters, spread accoss all key-value pairs. Annotations that go beyond this limit are rejected
  • Valid annotation keys have two segments: an optional prefix and name, separated by a slash (/). The name segment is required and must be 63 characters or less, beginning and ending with an alphanumeric character ([a-z0-9A-Z]) with dashes (-), underscores (_), dots (.), and alphanumerics between. The prefix is optional. If specified, the prefix must be a DNS subdomain: a series of DNS labels separated by dots (.), not longer than 253 characters in total, followed by a slash (/) Annotations that fails to meet these requirements are rejected.

Note: This field is equivalent to the metadata field in the v1beta1 API. They have the same syntax and read/write to the same location in Service Directory.

Property Value
TypeDescription
MapFieldstringstring

EndpointName

public EndpointName EndpointName { get; set; }

EndpointName-typed view over the Name resource name property.

Property Value
TypeDescription
EndpointName

Name

public string Name { get; set; }

Immutable. The resource name for the endpoint in the format projects/*/locations/*/namespaces/*/services/*/endpoints/*.

Property Value
TypeDescription
string

Network

public string Network { get; set; }

Immutable. The Google Compute Engine network (VPC) of the endpoint in the format projects/<project number>/locations/global/networks/*.

The project must be specified by project number (project id is rejected). Incorrectly formatted networks are rejected, we also check to make sure that you have the servicedirectory.networks.attach permission on the project specified.

Property Value
TypeDescription
string

NetworkAsNetworkName

public NetworkName NetworkAsNetworkName { get; set; }

NetworkName-typed view over the Network resource name property.

Property Value
TypeDescription
NetworkName

Port

public int Port { get; set; }

Optional. Service Directory rejects values outside of [0, 65535].

Property Value
TypeDescription
int

Uid

public string Uid { get; set; }

Output only. The globally unique identifier of the endpoint in the UUID4 format.

Property Value
TypeDescription
string