Class: Google::Apis::ServiceuserV1::Endpoint

Inherits:
Object
  • Object
show all
Includes:
Core::Hashable, Core::JsonObjectSupport
Defined in:
generated/google/apis/serviceuser_v1/classes.rb,
generated/google/apis/serviceuser_v1/representations.rb,
generated/google/apis/serviceuser_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

Methods included from Core::JsonObjectSupport

#to_json

Methods included from Core::Hashable

process_value, #to_h

Constructor Details

#initialize(**args) ⇒ Endpoint

Returns a new instance of Endpoint



910
911
912
 
# File 'generated/google/apis/serviceuser_v1/classes.rb', line 910

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 intented alias. Additional names that this endpoint will be hosted on. Corresponds to the JSON property aliases

Returns:

  • (Array<String>) 


871
872
873
 
# File 'generated/google/apis/serviceuser_v1/classes.rb', line 871

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) 


881
882
883
 
# File 'generated/google/apis/serviceuser_v1/classes.rb', line 881

def allow_cors
  @allow_cors
end

#apis ⇒ Array<String>

The list of APIs served by this endpoint. If no APIs are specified this translates to "all APIs" exported by the service, as defined in the top-level service configuration. Corresponds to the JSON property apis

Returns:

  • (Array<String>) 


889
890
891
 
# File 'generated/google/apis/serviceuser_v1/classes.rb', line 889

def apis
  @apis
end

#features ⇒ Array<String>

The list of features enabled on this endpoint. Corresponds to the JSON property features

Returns:

  • (Array<String>) 


894
895
896
 
# File 'generated/google/apis/serviceuser_v1/classes.rb', line 894

def features
  @features
end

#name ⇒ String

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

Returns:

  • (String) 


899
900
901
 
# File 'generated/google/apis/serviceuser_v1/classes.rb', line 899

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) 


908
909
910
 
# File 'generated/google/apis/serviceuser_v1/classes.rb', line 908

def target
  @target
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



915
916
917
918
919
920
921
922
 
# File 'generated/google/apis/serviceuser_v1/classes.rb', line 915

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