Service Directory V1beta1 API - Class Google::Cloud::ServiceDirectory::V1beta1::Endpoint (v0.11.1)

Reference documentation and code samples for the Service Directory V1beta1 API class Google::Cloud::ServiceDirectory::V1beta1::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.

#create_time

def create_time() -> ::Google::Protobuf::Timestamp

Returns

(::Google::Protobuf::Timestamp) — Output only. The timestamp when the endpoint was created.

#metadata

def metadata() -> ::Google::Protobuf::Map{::String => ::String}

Returns

(::Google::Protobuf::Map{::String => ::String}) — Optional. Metadata for the endpoint. This data can be consumed by service clients.

Restrictions:
- The entire metadata dictionary may contain up to 512 characters, spread accoss all key-value pairs. Metadata that goes beyond this limit are rejected
- Valid metadata 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 (/). Metadata that fails to meet these requirements are rejected
- The (*.)google.com/ and (*.)googleapis.com/ prefixes are reserved for system metadata managed by Service Directory. If the user tries to write to these keyspaces, those entries are silently ignored by the system
Note: This field is equivalent to the annotations field in the v1 API. They have the same syntax and read/write to the same location in Service Directory.

#metadata=

def metadata=(value) -> ::Google::Protobuf::Map{::String => ::String}

Parameter

value (::Google::Protobuf::Map{::String => ::String}) — Optional. Metadata for the endpoint. This data can be consumed by service clients.

Restrictions:
- The entire metadata dictionary may contain up to 512 characters, spread accoss all key-value pairs. Metadata that goes beyond this limit are rejected
- Valid metadata 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 (/). Metadata that fails to meet these requirements are rejected
- The (*.)google.com/ and (*.)googleapis.com/ prefixes are reserved for system metadata managed by Service Directory. If the user tries to write to these keyspaces, those entries are silently ignored by the system
Note: This field is equivalent to the annotations field in the v1 API. They have the same syntax and read/write to the same location in Service Directory.

Returns

(::Google::Protobuf::Map{::String => ::String}) — Optional. Metadata for the endpoint. This data can be consumed by service clients.

Restrictions:
- The entire metadata dictionary may contain up to 512 characters, spread accoss all key-value pairs. Metadata that goes beyond this limit are rejected
- Valid metadata 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 (/). Metadata that fails to meet these requirements are rejected
- The (*.)google.com/ and (*.)googleapis.com/ prefixes are reserved for system metadata managed by Service Directory. If the user tries to write to these keyspaces, those entries are silently ignored by the system
Note: This field is equivalent to the annotations field in the v1 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, but no other validation is performed on this field (ex. network or project existence, reachability, or permissions).

#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, but no other validation is performed on this field (ex. network or project existence, reachability, or permissions).

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, but no other validation is performed on this field (ex. network or project existence, reachability, or permissions).

#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].

#update_time

def update_time() -> ::Google::Protobuf::Timestamp

Returns

(::Google::Protobuf::Timestamp) — Output only. The timestamp when the endpoint was last updated.