Class: Google::Apis::ServicenetworkingV1::Endpoint

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

Overview

Endpoint describes a network endpoint that serves a set of APIs. A service may expose any number of endpoints, and all endpoints share the same service configuration, such as quota configuration and monitoring configuration. 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.



1427
1428
1429
 
# File 'generated/google/apis/servicenetworking_v1/classes.rb', line 1427

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>) 


1402
1403
1404
 
# File 'generated/google/apis/servicenetworking_v1/classes.rb', line 1402

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) 


1411
1412
1413
 
# File 'generated/google/apis/servicenetworking_v1/classes.rb', line 1411

def allow_cors
  @allow_cors
end

#name ⇒ String

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

Returns:

  • (String) 


1417
1418
1419
 
# File 'generated/google/apis/servicenetworking_v1/classes.rb', line 1417

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) 


1425
1426
1427
 
# File 'generated/google/apis/servicenetworking_v1/classes.rb', line 1425

def target
  @target
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



1432
1433
1434
1435
1436
1437
 
# File 'generated/google/apis/servicenetworking_v1/classes.rb', line 1432

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