Class: Google::Apis::TasksV1::Task

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

Defined Under Namespace

Classes: Link

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) ⇒ Task

Returns a new instance of Task.


119
120
121
# File 'generated/google/apis/tasks_v1/classes.rb', line 119

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

Instance Attribute Details

#completedString

Completion date of the task (as a RFC 3339 timestamp). This field is omitted if the task has not been completed. Corresponds to the JSON property completed

Returns:

  • (String)

33
34
35
# File 'generated/google/apis/tasks_v1/classes.rb', line 33

def completed
  @completed
end

#deletedBoolean Also known as: deleted?

Flag indicating whether the task has been deleted. The default is False. Corresponds to the JSON property deleted

Returns:

  • (Boolean)

38
39
40
# File 'generated/google/apis/tasks_v1/classes.rb', line 38

def deleted
  @deleted
end

#dueString

Due date of the task (as a RFC 3339 timestamp). Optional. The due date only records date information; the time portion of the timestamp is discarded when setting the due date. It isn't possible to read or write the time that a task is due via the API. Corresponds to the JSON property due

Returns:

  • (String)

47
48
49
# File 'generated/google/apis/tasks_v1/classes.rb', line 47

def due
  @due
end

#etagString

ETag of the resource. Corresponds to the JSON property etag

Returns:

  • (String)

52
53
54
# File 'generated/google/apis/tasks_v1/classes.rb', line 52

def etag
  @etag
end

#hiddenBoolean Also known as: hidden?

Flag indicating whether the task is hidden. This is the case if the task had been marked completed when the task list was last cleared. The default is False. This field is read-only. Corresponds to the JSON property hidden

Returns:

  • (Boolean)

59
60
61
# File 'generated/google/apis/tasks_v1/classes.rb', line 59

def hidden
  @hidden
end

#idString

Task identifier. Corresponds to the JSON property id

Returns:

  • (String)

65
66
67
# File 'generated/google/apis/tasks_v1/classes.rb', line 65

def id
  @id
end

#kindString

Type of the resource. This is always "tasks#task". Corresponds to the JSON property kind

Returns:

  • (String)

70
71
72
# File 'generated/google/apis/tasks_v1/classes.rb', line 70

def kind
  @kind
end

Collection of links. This collection is read-only. Corresponds to the JSON property links


75
76
77
# File 'generated/google/apis/tasks_v1/classes.rb', line 75

def links
  @links
end

#notesString

Notes describing the task. Optional. Corresponds to the JSON property notes

Returns:

  • (String)

80
81
82
# File 'generated/google/apis/tasks_v1/classes.rb', line 80

def notes
  @notes
end

#parentString

Parent task identifier. This field is omitted if it is a top-level task. This field is read-only. Use the "move" method to move the task under a different parent or to the top level. Corresponds to the JSON property parent

Returns:

  • (String)

87
88
89
# File 'generated/google/apis/tasks_v1/classes.rb', line 87

def parent
  @parent
end

#positionString

String indicating the position of the task among its sibling tasks under the same parent task or at the top level. If this string is greater than another task's corresponding position string according to lexicographical ordering, the task is positioned after the other task under the same parent task (or at the top level). This field is read-only. Use the "move" method to move the task to another position. Corresponds to the JSON property position

Returns:

  • (String)

97
98
99
# File 'generated/google/apis/tasks_v1/classes.rb', line 97

def position
  @position
end

URL pointing to this task. Used to retrieve, update, or delete this task. Corresponds to the JSON property selfLink

Returns:

  • (String)

102
103
104
# File 'generated/google/apis/tasks_v1/classes.rb', line 102

def self_link
  @self_link
end

#statusString

Status of the task. This is either "needsAction" or "completed". Corresponds to the JSON property status

Returns:

  • (String)

107
108
109
# File 'generated/google/apis/tasks_v1/classes.rb', line 107

def status
  @status
end

#titleString

Title of the task. Corresponds to the JSON property title

Returns:

  • (String)

112
113
114
# File 'generated/google/apis/tasks_v1/classes.rb', line 112

def title
  @title
end

#updatedString

Last modification time of the task (as a RFC 3339 timestamp). Corresponds to the JSON property updated

Returns:

  • (String)

117
118
119
# File 'generated/google/apis/tasks_v1/classes.rb', line 117

def updated
  @updated
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object


124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
# File 'generated/google/apis/tasks_v1/classes.rb', line 124

def update!(**args)
  @completed = args[:completed] if args.key?(:completed)
  @deleted = args[:deleted] if args.key?(:deleted)
  @due = args[:due] if args.key?(:due)
  @etag = args[:etag] if args.key?(:etag)
  @hidden = args[:hidden] if args.key?(:hidden)
  @id = args[:id] if args.key?(:id)
  @kind = args[:kind] if args.key?(:kind)
  @links = args[:links] if args.key?(:links)
  @notes = args[:notes] if args.key?(:notes)
  @parent = args[:parent] if args.key?(:parent)
  @position = args[:position] if args.key?(:position)
  @self_link = args[:self_link] if args.key?(:self_link)
  @status = args[:status] if args.key?(:status)
  @title = args[:title] if args.key?(:title)
  @updated = args[:updated] if args.key?(:updated)
end