Class: Ecfr::AdminService::Build

Inherits:
Base show all
Defined in:
lib/ecfr/admin_service/build.rb

Constant Summary collapse

BUILDS_PATH = 
"v1/builds"

Constants inherited from Base

Base::SUPPORTED_ARRAY_ACCESSORS

Instance Attribute Summary collapse

Attributes inherited from Base

#metadata, #request_data, #response_status, #results

Class Method Summary collapse

Methods inherited from Base

base_url, service_name, service_path

Methods inherited from Base

basic_auth_client_options, #each, #initialize, metadata, metadata_key, result_key

Methods included from Extensible

#inherited

Methods included from Ecfr::AttributeMethodDefinition

included, #initialize

Methods inherited from Client

build, cache_key, client, client_pool, delete, execute, get, handle_response, perform, post, purge

Methods included from ParallelClient

included

Constructor Details

This class inherits a constructor from Ecfr::Base

Instance Attribute Details

#expired ⇒ Boolean (readonly)

Returns:

  • (Boolean) 


11
12
 
# File 'lib/ecfr/admin_service/build.rb', line 11

attribute :expired,
type: :boolean

#id ⇒ String (readonly)

build id

Returns:

  • (String) 


6
7
 
# File 'lib/ecfr/admin_service/build.rb', line 6

attribute :id,
desc: "build id"

#previewable ⇒ Boolean (readonly)

Returns:

  • (Boolean) 


13
14
 
# File 'lib/ecfr/admin_service/build.rb', line 13

attribute :previewable,
type: :boolean

#status ⇒ String (readonly)

build status - either Success or Failure

Returns:

  • (String) 


8
9
 
# File 'lib/ecfr/admin_service/build.rb', line 8

attribute :status,
desc: "build status - either *Success* or *Failure*"

Class Method Details

.find(build_id) ⇒ <Build>

Retrieve a Build by id

Parameters:

  • build_id (<String>) —

    • id of the desired build

Returns:

  • (<Build>) —

    data for a single build



25
26
27
28
29
30
 
# File 'lib/ecfr/admin_service/build.rb', line 25

def self.find(build_id)
  perform(
    :get,
    build_path(build_id)
  )
end