Class: Google::Apis::DiscoveryV1::RestDescription

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

Defined Under Namespace

Classes: Auth, Endpoint, Icons

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(**args) ⇒ RestDescription

Returns a new instance of RestDescription.



566
567
568
 
# File 'lib/google/apis/discovery_v1/classes.rb', line 566

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

Instance Attribute Details

#api_methods ⇒ Hash<String,Google::Apis::DiscoveryV1::RestMethod>

API-level methods for this API. Corresponds to the JSON property methods

Returns:



491
492
493
 
# File 'lib/google/apis/discovery_v1/classes.rb', line 491

def api_methods
  @api_methods
end

#auth ⇒ Google::Apis::DiscoveryV1::RestDescription::Auth

Authentication information. Corresponds to the JSON property auth

Returns:



408
409
410
 
# File 'lib/google/apis/discovery_v1/classes.rb', line 408

def auth
  @auth
end

#base_path ⇒ String

[DEPRECATED] The base path for REST requests. Corresponds to the JSON property basePath

Returns:

  • (String) 


413
414
415
 
# File 'lib/google/apis/discovery_v1/classes.rb', line 413

def base_path
  @base_path
end

#base_url ⇒ String

[DEPRECATED] The base URL for REST requests. Corresponds to the JSON property baseUrl

Returns:

  • (String) 


418
419
420
 
# File 'lib/google/apis/discovery_v1/classes.rb', line 418

def base_url
  @base_url
end

#batch_path ⇒ String

The path for REST batch requests. Corresponds to the JSON property batchPath

Returns:

  • (String) 


423
424
425
 
# File 'lib/google/apis/discovery_v1/classes.rb', line 423

def batch_path
  @batch_path
end

#canonical_name ⇒ String

Indicates how the API name should be capitalized and split into various parts. Useful for generating pretty class names. Corresponds to the JSON property canonicalName

Returns:

  • (String) 


429
430
431
 
# File 'lib/google/apis/discovery_v1/classes.rb', line 429

def canonical_name
  @canonical_name
end

#description ⇒ String

The description of this API. Corresponds to the JSON property description

Returns:

  • (String) 


434
435
436
 
# File 'lib/google/apis/discovery_v1/classes.rb', line 434

def description
  @description
end

#discovery_version ⇒ String

Indicate the version of the Discovery API used to generate this doc. Corresponds to the JSON property discoveryVersion

Returns:

  • (String) 


439
440
441
 
# File 'lib/google/apis/discovery_v1/classes.rb', line 439

def discovery_version
  @discovery_version
end

#documentation_link ⇒ String

A link to human readable documentation for the API. Corresponds to the JSON property documentationLink

Returns:

  • (String) 


444
445
446
 
# File 'lib/google/apis/discovery_v1/classes.rb', line 444

def documentation_link
  @documentation_link
end

#endpoints ⇒ Array<Google::Apis::DiscoveryV1::RestDescription::Endpoint>

A list of location-based endpoint objects for this API. Each object contains the endpoint URL, location, description and deprecation status. Corresponds to the JSON property endpoints

Returns:



450
451
452
 
# File 'lib/google/apis/discovery_v1/classes.rb', line 450

def endpoints
  @endpoints
end

#etag ⇒ String

The ETag for this response. Corresponds to the JSON property etag

Returns:

  • (String) 


455
456
457
 
# File 'lib/google/apis/discovery_v1/classes.rb', line 455

def etag
  @etag
end

#exponential_backoff_default ⇒ Boolean Also known as: exponential_backoff_default?

Enable exponential backoff for suitable methods in the generated clients. Corresponds to the JSON property exponentialBackoffDefault

Returns:

  • (Boolean) 


460
461
462
 
# File 'lib/google/apis/discovery_v1/classes.rb', line 460

def exponential_backoff_default
  @exponential_backoff_default
end

#features ⇒ Array<String>

A list of supported features for this API. Corresponds to the JSON property features

Returns:

  • (Array<String>) 


466
467
468
 
# File 'lib/google/apis/discovery_v1/classes.rb', line 466

def features
  @features
end

#icons ⇒ Google::Apis::DiscoveryV1::RestDescription::Icons

Links to 16x16 and 32x32 icons representing the API. Corresponds to the JSON property icons

Returns:



471
472
473
 
# File 'lib/google/apis/discovery_v1/classes.rb', line 471

def icons
  @icons
end

#id ⇒ String

The ID of this API. Corresponds to the JSON property id

Returns:

  • (String) 


476
477
478
 
# File 'lib/google/apis/discovery_v1/classes.rb', line 476

def id
  @id
end

#kind ⇒ String

The kind for this response. Corresponds to the JSON property kind

Returns:

  • (String) 


481
482
483
 
# File 'lib/google/apis/discovery_v1/classes.rb', line 481

def kind
  @kind
end

#labels ⇒ Array<String>

Labels for the status of this API, such as labs or deprecated. Corresponds to the JSON property labels

Returns:

  • (Array<String>) 


486
487
488
 
# File 'lib/google/apis/discovery_v1/classes.rb', line 486

def labels
  @labels
end

#name ⇒ String

The name of this API. Corresponds to the JSON property name

Returns:

  • (String) 


496
497
498
 
# File 'lib/google/apis/discovery_v1/classes.rb', line 496

def name
  @name
end

#owner_domain ⇒ String

The domain of the owner of this API. Together with the ownerName and a packagePath values, this can be used to generate a library for this API which would have a unique fully qualified name. Corresponds to the JSON property ownerDomain

Returns:

  • (String) 


503
504
505
 
# File 'lib/google/apis/discovery_v1/classes.rb', line 503

def owner_domain
  @owner_domain
end

#owner_name ⇒ String

The name of the owner of this API. See ownerDomain. Corresponds to the JSON property ownerName

Returns:

  • (String) 


508
509
510
 
# File 'lib/google/apis/discovery_v1/classes.rb', line 508

def owner_name
  @owner_name
end

#package_path ⇒ String

The package of the owner of this API. See ownerDomain. Corresponds to the JSON property packagePath

Returns:

  • (String) 


513
514
515
 
# File 'lib/google/apis/discovery_v1/classes.rb', line 513

def package_path
  @package_path
end

#parameters ⇒ Hash<String,Google::Apis::DiscoveryV1::JsonSchema>

Common parameters that apply across all apis. Corresponds to the JSON property parameters

Returns:



518
519
520
 
# File 'lib/google/apis/discovery_v1/classes.rb', line 518

def parameters
  @parameters
end

#protocol ⇒ String

The protocol described by this document. Corresponds to the JSON property protocol

Returns:

  • (String) 


523
524
525
 
# File 'lib/google/apis/discovery_v1/classes.rb', line 523

def protocol
  @protocol
end

#resources ⇒ Hash<String,Google::Apis::DiscoveryV1::RestResource>

The resources in this API. Corresponds to the JSON property resources

Returns:



528
529
530
 
# File 'lib/google/apis/discovery_v1/classes.rb', line 528

def resources
  @resources
end

#revision ⇒ String

The version of this API. Corresponds to the JSON property revision

Returns:

  • (String) 


533
534
535
 
# File 'lib/google/apis/discovery_v1/classes.rb', line 533

def revision
  @revision
end

#root_url ⇒ String

The root URL under which all API services live. Corresponds to the JSON property rootUrl

Returns:

  • (String) 


538
539
540
 
# File 'lib/google/apis/discovery_v1/classes.rb', line 538

def root_url
  @root_url
end

#schemas ⇒ Hash<String,Google::Apis::DiscoveryV1::JsonSchema>

The schemas for this API. Corresponds to the JSON property schemas

Returns:



543
544
545
 
# File 'lib/google/apis/discovery_v1/classes.rb', line 543

def schemas
  @schemas
end

#service_path ⇒ String

The base path for all REST requests. Corresponds to the JSON property servicePath

Returns:

  • (String) 


548
549
550
 
# File 'lib/google/apis/discovery_v1/classes.rb', line 548

def service_path
  @service_path
end

#title ⇒ String

The title of this API. Corresponds to the JSON property title

Returns:

  • (String) 


553
554
555
 
# File 'lib/google/apis/discovery_v1/classes.rb', line 553

def title
  @title
end

#version ⇒ String

The version of this API. Corresponds to the JSON property version

Returns:

  • (String) 


558
559
560
 
# File 'lib/google/apis/discovery_v1/classes.rb', line 558

def version
  @version
end

#version_module ⇒ Boolean Also known as: version_module?

Corresponds to the JSON property version_module

Returns:

  • (Boolean) 


563
564
565
 
# File 'lib/google/apis/discovery_v1/classes.rb', line 563

def version_module
  @version_module
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
 
# File 'lib/google/apis/discovery_v1/classes.rb', line 571

def update!(**args)
  @auth = args[:auth] if args.key?(:auth)
  @base_path = args[:base_path] if args.key?(:base_path)
  @base_url = args[:base_url] if args.key?(:base_url)
  @batch_path = args[:batch_path] if args.key?(:batch_path)
  @canonical_name = args[:canonical_name] if args.key?(:canonical_name)
  @description = args[:description] if args.key?(:description)
  @discovery_version = args[:discovery_version] if args.key?(:discovery_version)
  @documentation_link = args[:documentation_link] if args.key?(:documentation_link)
  @endpoints = args[:endpoints] if args.key?(:endpoints)
  @etag = args[:etag] if args.key?(:etag)
  @exponential_backoff_default = args[:exponential_backoff_default] if args.key?(:exponential_backoff_default)
  @features = args[:features] if args.key?(:features)
  @icons = args[:icons] if args.key?(:icons)
  @id = args[:id] if args.key?(:id)
  @kind = args[:kind] if args.key?(:kind)
  @labels = args[:labels] if args.key?(:labels)
  @api_methods = args[:api_methods] if args.key?(:api_methods)
  @name = args[:name] if args.key?(:name)
  @owner_domain = args[:owner_domain] if args.key?(:owner_domain)
  @owner_name = args[:owner_name] if args.key?(:owner_name)
  @package_path = args[:package_path] if args.key?(:package_path)
  @parameters = args[:parameters] if args.key?(:parameters)
  @protocol = args[:protocol] if args.key?(:protocol)
  @resources = args[:resources] if args.key?(:resources)
  @revision = args[:revision] if args.key?(:revision)
  @root_url = args[:root_url] if args.key?(:root_url)
  @schemas = args[:schemas] if args.key?(:schemas)
  @service_path = args[:service_path] if args.key?(:service_path)
  @title = args[:title] if args.key?(:title)
  @version = args[:version] if args.key?(:version)
  @version_module = args[:version_module] if args.key?(:version_module)
end