Service Directory V1 API - Class Google::Cloud::ServiceDirectory::V1::Endpoint (v1.1.0)

Reference documentation and code samples for the Service Directory V1 API class Google::Cloud::ServiceDirectory::V1::Endpoint.

An individual endpoint that provides a service. The service must already exist to create an endpoint.

Inherits

  • Object

Extended By

  • Google::Protobuf::MessageExts::ClassMethods

Includes

  • Google::Protobuf::MessageExts

Methods

#address

def address() -> ::String
Returns
  • (::String) — 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.

#address=

def address=(value) -> ::String
Parameter
  • value (::String) — 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.

Returns
  • (::String) — 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.

#annotations

def annotations() -> ::Google::Protobuf::Map{::String => ::String}
Returns
  • (::Google::Protobuf::Map{::String => ::String}) — 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.

#annotations=

def annotations=(value) -> ::Google::Protobuf::Map{::String => ::String}
Parameter
  • value (::Google::Protobuf::Map{::String => ::String}) — 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.

Returns
  • (::Google::Protobuf::Map{::String => ::String}) — 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.

#name

def name() -> ::String
Returns
  • (::String) — Immutable. The resource name for the endpoint in the format projects/*/locations/*/namespaces/*/services/*/endpoints/*.

#name=

def name=(value) -> ::String
Parameter
  • value (::String) — Immutable. The resource name for the endpoint in the format projects/*/locations/*/namespaces/*/services/*/endpoints/*.
Returns
  • (::String) — Immutable. The resource name for the endpoint in the format projects/*/locations/*/namespaces/*/services/*/endpoints/*.

#network

def network() -> ::String
Returns
  • (::String) — 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.

#network=

def network=(value) -> ::String
Parameter
  • value (::String) — 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.

Returns
  • (::String) — 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.

#port

def port() -> ::Integer
Returns
  • (::Integer) — Optional. Service Directory rejects values outside of [0, 65535].

#port=

def port=(value) -> ::Integer
Parameter
  • value (::Integer) — Optional. Service Directory rejects values outside of [0, 65535].
Returns
  • (::Integer) — Optional. Service Directory rejects values outside of [0, 65535].

#uid

def uid() -> ::String
Returns
  • (::String) — Output only. The globally unique identifier of the endpoint in the UUID4 format.