Class: Google::Apis::ServiceusageV1::Endpoint

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



1233
1234
1235
# File 'generated/google/apis/serviceusage_v1/classes.rb', line 1233

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

Instance Attribute Details

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


1201
1202
1203
# File 'generated/google/apis/serviceusage_v1/classes.rb', line 1201

def aliases
  @aliases
end

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


1211
1212
1213
# File 'generated/google/apis/serviceusage_v1/classes.rb', line 1211

def allow_cors
  @allow_cors
end

#featuresArray<String>

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

Returns:

  • (Array<String>)


1217
1218
1219
# File 'generated/google/apis/serviceusage_v1/classes.rb', line 1217

def features
  @features
end

#nameString

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

Returns:

  • (String)


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

def name
  @name
end

#targetString

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)


1231
1232
1233
# File 'generated/google/apis/serviceusage_v1/classes.rb', line 1231

def target
  @target
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



1238
1239
1240
1241
1242
1243
1244
# File 'generated/google/apis/serviceusage_v1/classes.rb', line 1238

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