Class: Google::Apis::ServicedirectoryV1::Endpoint

Inherits:
Object
  • Object
show all
Includes:
Core::Hashable, Core::JsonObjectSupport
Defined in:
generated/google/apis/servicedirectory_v1/classes.rb,
generated/google/apis/servicedirectory_v1/representations.rb,
generated/google/apis/servicedirectory_v1/representations.rb

Overview

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

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(**args) ⇒ Endpoint

Returns a new instance of Endpoint.



156
157
158
 
# File 'generated/google/apis/servicedirectory_v1/classes.rb', line 156

def initialize(**args)
   update!(**args)
end

Instance Attribute Details

#address ⇒ String

Optional. An IPv4 or IPv6 address. Service Directory will reject bad addresses like: "8.8.8" "8.8.8.8:53" "test:bad:address" "[::1]" "[::1]:8080" Limited to 45 characters. Corresponds to the JSON property address

Returns:

  • (String) 


123
124
125
 
# File 'generated/google/apis/servicedirectory_v1/classes.rb', line 123

def address
  @address
end

#annotations ⇒ Hash<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 goes beyond any these limits will be 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 will be rejected. - The '(.)google.com/' and '(.)googleapis.com/' prefixes are reserved for system annotations managed by Service Directory. If the user tries to write to these keyspaces, those entries will be silently ignored by the system. 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. Corresponds to the JSON property annotations

Returns:

  • (Hash<String,String>) 


143
144
145
 
# File 'generated/google/apis/servicedirectory_v1/classes.rb', line 143

def annotations
  @annotations
end

#name ⇒ String

Immutable. The resource name for the endpoint in the format 'projects// locations//namespaces//services//endpoints/*'. Corresponds to the JSON property name

Returns:

  • (String) 


149
150
151
 
# File 'generated/google/apis/servicedirectory_v1/classes.rb', line 149

def name
  @name
end

#port ⇒ Fixnum

Optional. Service Directory will reject values outside of [0, 65535]. Corresponds to the JSON property port

Returns:

  • (Fixnum) 


154
155
156
 
# File 'generated/google/apis/servicedirectory_v1/classes.rb', line 154

def port
  @port
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



161
162
163
164
165
166
 
# File 'generated/google/apis/servicedirectory_v1/classes.rb', line 161

def update!(**args)
  @address = args[:address] if args.key?(:address)
  @annotations = args[:annotations] if args.key?(:annotations)
  @name = args[:name] if args.key?(:name)
  @port = args[:port] if args.key?(:port)
end