Class: Google::Apis::ServicemanagementV1::Endpoint

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

Overview

Endpoint describes a network endpoint 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 service configuration: name: library-example.googleapis.com endpoints: # Below entry makes 'google.example.library.v1.Library' # API be served from endpoint address library-example.googleapis.com. # It also allows HTTP OPTIONS calls to be passed to the backend, for # it to decide whether the subsequent cross- origin request is # allowed to proceed. - name: library-example.googleapis.com allow_cors: true

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(**args) ⇒ Endpoint

Returns a new instance of Endpoint.



1232
1233
1234
 
# File 'generated/google/apis/servicemanagement_v1/classes.rb', line 1232

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

Instance Attribute Details

#aliases ⇒ Array<String>

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. Corresponds to the JSON property aliases

Returns:

  • (Array<String>) 


1207
1208
1209
 
# File 'generated/google/apis/servicemanagement_v1/classes.rb', line 1207

def aliases
  @aliases
end

#allow_cors ⇒ Boolean Also known as: allow_cors?

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. Corresponds to the JSON property allowCors

Returns:

  • (Boolean) 


1216
1217
1218
 
# File 'generated/google/apis/servicemanagement_v1/classes.rb', line 1216

def allow_cors
  @allow_cors
end

#name ⇒ String

The canonical name of this endpoint. Corresponds to the JSON property name

Returns:

  • (String) 


1222
1223
1224
 
# File 'generated/google/apis/servicemanagement_v1/classes.rb', line 1222

def name
  @name
end

#target ⇒ String

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". Corresponds to the JSON property target

Returns:

  • (String) 


1230
1231
1232
 
# File 'generated/google/apis/servicemanagement_v1/classes.rb', line 1230

def target
  @target
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



1237
1238
1239
1240
1241
1242
 
# File 'generated/google/apis/servicemanagement_v1/classes.rb', line 1237

def update!(**args)
  @aliases = args[:aliases] if args.key?(:aliases)
  @allow_cors = args[:allow_cors] if args.key?(:allow_cors)
  @name = args[:name] if args.key?(:name)
  @target = args[:target] if args.key?(:target)
end