Class: Google::Apis::CivicinfoV2::Contest

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

Overview

Information about a contest that appears on a voter's ballot.

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(**args) ⇒ Contest

Returns a new instance of Contest.



418
419
420
 
# File 'generated/google/apis/civicinfo_v2/classes.rb', line 418

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

Instance Attribute Details

#ballot_placement ⇒ Fixnum

A number specifying the position of this contest on the voter's ballot. Corresponds to the JSON property ballotPlacement

Returns:

  • (Fixnum) 


272
273
274
 
# File 'generated/google/apis/civicinfo_v2/classes.rb', line 272

def ballot_placement
  @ballot_placement
end

#ballot_title ⇒ String

The official title on the ballot for this contest, only where available. Corresponds to the JSON property ballotTitle

Returns:

  • (String) 


277
278
279
 
# File 'generated/google/apis/civicinfo_v2/classes.rb', line 277

def ballot_title
  @ballot_title
end

#candidates ⇒ Array<Google::Apis::CivicinfoV2::Candidate>

The candidate choices for this contest. Corresponds to the JSON property candidates

Returns:



282
283
284
 
# File 'generated/google/apis/civicinfo_v2/classes.rb', line 282

def candidates
  @candidates
end

#district ⇒ Google::Apis::CivicinfoV2::ElectoralDistrict

Describes the geographic scope of a contest. Corresponds to the JSON property district

Returns:



287
288
289
 
# File 'generated/google/apis/civicinfo_v2/classes.rb', line 287

def district
  @district
end

#electorate_specifications ⇒ String

A description of any additional eligibility requirements for voting in this contest. Corresponds to the JSON property electorateSpecifications

Returns:

  • (String) 


293
294
295
 
# File 'generated/google/apis/civicinfo_v2/classes.rb', line 293

def electorate_specifications
  @electorate_specifications
end

#level ⇒ Array<String>

The levels of government of the office for this contest. There may be more than one in cases where a jurisdiction effectively acts at two different levels of government; for example, the mayor of the District of Columbia acts at "locality" level, but also effectively at both "administrative-area-2" and " administrative-area-1". Corresponds to the JSON property level

Returns:

  • (Array<String>) 


302
303
304
 
# File 'generated/google/apis/civicinfo_v2/classes.rb', line 302

def level
  @level
end

#number_elected ⇒ Fixnum

The number of candidates that will be elected to office in this contest. Corresponds to the JSON property numberElected

Returns:

  • (Fixnum) 


307
308
309
 
# File 'generated/google/apis/civicinfo_v2/classes.rb', line 307

def number_elected
  @number_elected
end

#number_voting_for ⇒ Fixnum

The number of candidates that a voter may vote for in this contest. Corresponds to the JSON property numberVotingFor

Returns:

  • (Fixnum) 


312
313
314
 
# File 'generated/google/apis/civicinfo_v2/classes.rb', line 312

def number_voting_for
  @number_voting_for
end

#office ⇒ String

The name of the office for this contest. Corresponds to the JSON property office

Returns:

  • (String) 


317
318
319
 
# File 'generated/google/apis/civicinfo_v2/classes.rb', line 317

def office
  @office
end

#primary_parties ⇒ Array<String>

If this is a partisan election, the name of the party/parties it is for. Corresponds to the JSON property primaryParties

Returns:

  • (Array<String>) 


322
323
324
 
# File 'generated/google/apis/civicinfo_v2/classes.rb', line 322

def primary_parties
  @primary_parties
end

#primary_party ⇒ String

[DEPRECATED] If this is a partisan election, the name of the party it is for. This field as deprecated in favor of the array "primaryParties", as contests may contain more than one party. Corresponds to the JSON property primaryParty

Returns:

  • (String) 


329
330
331
 
# File 'generated/google/apis/civicinfo_v2/classes.rb', line 329

def primary_party
  @primary_party
end

#referendum_ballot_responses ⇒ Array<String>

The set of ballot responses for the referendum. A ballot response represents a line on the ballot. Common examples might include "yes" or "no" for referenda. This field is only populated for contests of type 'Referendum'. Corresponds to the JSON property referendumBallotResponses

Returns:

  • (Array<String>) 


336
337
338
 
# File 'generated/google/apis/civicinfo_v2/classes.rb', line 336

def referendum_ballot_responses
  @referendum_ballot_responses
end

#referendum_brief ⇒ String

Specifies a short summary of the referendum that is typically on the ballot below the title but above the text. This field is only populated for contests of type 'Referendum'. Corresponds to the JSON property referendumBrief

Returns:

  • (String) 


343
344
345
 
# File 'generated/google/apis/civicinfo_v2/classes.rb', line 343

def referendum_brief
  @referendum_brief
end

#referendum_con_statement ⇒ String

A statement in opposition to the referendum. It does not necessarily appear on the ballot. This field is only populated for contests of type 'Referendum'. Corresponds to the JSON property referendumConStatement

Returns:

  • (String) 


349
350
351
 
# File 'generated/google/apis/civicinfo_v2/classes.rb', line 349

def referendum_con_statement
  @referendum_con_statement
end

#referendum_effect_of_abstain ⇒ String

Specifies what effect abstaining (not voting) on the proposition will have (i. e. whether abstaining is considered a vote against it). This field is only populated for contests of type 'Referendum'. Corresponds to the JSON property referendumEffectOfAbstain

Returns:

  • (String) 


356
357
358
 
# File 'generated/google/apis/civicinfo_v2/classes.rb', line 356

def referendum_effect_of_abstain
  @referendum_effect_of_abstain
end

#referendum_passage_threshold ⇒ String

The threshold of votes that the referendum needs in order to pass, e.g. "two- thirds". This field is only populated for contests of type 'Referendum'. Corresponds to the JSON property referendumPassageThreshold

Returns:

  • (String) 


362
363
364
 
# File 'generated/google/apis/civicinfo_v2/classes.rb', line 362

def referendum_passage_threshold
  @referendum_passage_threshold
end

#referendum_pro_statement ⇒ String

A statement in favor of the referendum. It does not necessarily appear on the ballot. This field is only populated for contests of type 'Referendum'. Corresponds to the JSON property referendumProStatement

Returns:

  • (String) 


368
369
370
 
# File 'generated/google/apis/civicinfo_v2/classes.rb', line 368

def referendum_pro_statement
  @referendum_pro_statement
end

#referendum_subtitle ⇒ String

A brief description of the referendum. This field is only populated for contests of type 'Referendum'. Corresponds to the JSON property referendumSubtitle

Returns:

  • (String) 


374
375
376
 
# File 'generated/google/apis/civicinfo_v2/classes.rb', line 374

def referendum_subtitle
  @referendum_subtitle
end

#referendum_text ⇒ String

The full text of the referendum. This field is only populated for contests of type 'Referendum'. Corresponds to the JSON property referendumText

Returns:

  • (String) 


380
381
382
 
# File 'generated/google/apis/civicinfo_v2/classes.rb', line 380

def referendum_text
  @referendum_text
end

#referendum_title ⇒ String

The title of the referendum (e.g. 'Proposition 42'). This field is only populated for contests of type 'Referendum'. Corresponds to the JSON property referendumTitle

Returns:

  • (String) 


386
387
388
 
# File 'generated/google/apis/civicinfo_v2/classes.rb', line 386

def referendum_title
  @referendum_title
end

#referendum_url ⇒ String

A link to the referendum. This field is only populated for contests of type ' Referendum'. Corresponds to the JSON property referendumUrl

Returns:

  • (String) 


392
393
394
 
# File 'generated/google/apis/civicinfo_v2/classes.rb', line 392

def referendum_url
  @referendum_url
end

#roles ⇒ Array<String>

The roles which this office fulfills. Corresponds to the JSON property roles

Returns:

  • (Array<String>) 


397
398
399
 
# File 'generated/google/apis/civicinfo_v2/classes.rb', line 397

def roles
  @roles
end

#sources ⇒ Array<Google::Apis::CivicinfoV2::Source>

A list of sources for this contest. If multiple sources are listed, the data has been aggregated from those sources. Corresponds to the JSON property sources

Returns:



403
404
405
 
# File 'generated/google/apis/civicinfo_v2/classes.rb', line 403

def sources
  @sources
end

#special ⇒ String

"Yes" or "No" depending on whether this a contest being held outside the normal election cycle. Corresponds to the JSON property special

Returns:

  • (String) 


409
410
411
 
# File 'generated/google/apis/civicinfo_v2/classes.rb', line 409

def special
  @special
end

#type ⇒ String

The type of contest. Usually this will be 'General', 'Primary', or 'Run-off' for contests with candidates. For referenda this will be 'Referendum'. For Retention contests this will typically be 'Retention'. Corresponds to the JSON property type

Returns:

  • (String) 


416
417
418
 
# File 'generated/google/apis/civicinfo_v2/classes.rb', line 416

def type
  @type
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
 
# File 'generated/google/apis/civicinfo_v2/classes.rb', line 423

def update!(**args)
  @ballot_placement = args[:ballot_placement] if args.key?(:ballot_placement)
  @ballot_title = args[:ballot_title] if args.key?(:ballot_title)
  @candidates = args[:candidates] if args.key?(:candidates)
  @district = args[:district] if args.key?(:district)
  @electorate_specifications = args[:electorate_specifications] if args.key?(:electorate_specifications)
  @level = args[:level] if args.key?(:level)
  @number_elected = args[:number_elected] if args.key?(:number_elected)
  @number_voting_for = args[:number_voting_for] if args.key?(:number_voting_for)
  @office = args[:office] if args.key?(:office)
  @primary_parties = args[:primary_parties] if args.key?(:primary_parties)
  @primary_party = args[:primary_party] if args.key?(:primary_party)
  @referendum_ballot_responses = args[:referendum_ballot_responses] if args.key?(:referendum_ballot_responses)
  @referendum_brief = args[:referendum_brief] if args.key?(:referendum_brief)
  @referendum_con_statement = args[:referendum_con_statement] if args.key?(:referendum_con_statement)
  @referendum_effect_of_abstain = args[:referendum_effect_of_abstain] if args.key?(:referendum_effect_of_abstain)
  @referendum_passage_threshold = args[:referendum_passage_threshold] if args.key?(:referendum_passage_threshold)
  @referendum_pro_statement = args[:referendum_pro_statement] if args.key?(:referendum_pro_statement)
  @referendum_subtitle = args[:referendum_subtitle] if args.key?(:referendum_subtitle)
  @referendum_text = args[:referendum_text] if args.key?(:referendum_text)
  @referendum_title = args[:referendum_title] if args.key?(:referendum_title)
  @referendum_url = args[:referendum_url] if args.key?(:referendum_url)
  @roles = args[:roles] if args.key?(:roles)
  @sources = args[:sources] if args.key?(:sources)
  @special = args[:special] if args.key?(:special)
  @type = args[:type] if args.key?(:type)
end