class Google::Apis::CoordinateV1::CoordinateService
Google Maps Coordinate API
Lets you view and manage jobs in a Coordinate team.
@example
require 'google/apis/coordinate_v1' Coordinate = Google::Apis::CoordinateV1 # Alias the module service = Coordinate::CoordinateService.new
Attributes
@return [String]
API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.
@return [String]
Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. Overrides userIp if both are provided.
@return [String]
IP address of the site where the request originates. Use this if you want to enforce per-user limits.
Public Class Methods
# File generated/google/apis/coordinate_v1/service.rb, line 51 def initialize super('https://www.googleapis.com/', 'coordinate/v1/') end
Public Instance Methods
Retrieves a job, including all the changes made to the job. @param [String] team_id
Team ID
@param [String] job_id
Job number
@param [String] fields
Selector specifying which fields to include in a partial response.
@param [String] #quota_user
Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. Overrides userIp if both are provided.
@param [String] #user_ip
IP address of the site where the request originates. Use this if you want to enforce per-user limits.
@param [Google::Apis::RequestOptions] options
Request-specific options
@yield [result, err] Result & error if block supplied @yieldparam result [Google::Apis::CoordinateV1::Job] parsed result object @yieldparam err [StandardError] error object if request failed
@return [Google::Apis::CoordinateV1::Job]
@raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification @raise [Google::Apis::AuthorizationError] Authorization is required
# File generated/google/apis/coordinate_v1/service.rb, line 116 def get_job(team_id, job_id, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) command = make_simple_command(:get, 'teams/{teamId}/jobs/{jobId}', options) command.response_representation = Google::Apis::CoordinateV1::Job::Representation command.response_class = Google::Apis::CoordinateV1::Job command.params['teamId'] = team_id unless team_id.nil? command.params['jobId'] = job_id unless job_id.nil? command.query['fields'] = fields unless fields.nil? command.query['quotaUser'] = quota_user unless quota_user.nil? command.query['userIp'] = user_ip unless user_ip.nil? execute_or_queue_command(command, &block) end
Retrieves the schedule for a job. @param [String] team_id
Team ID
@param [String] job_id
Job number
@param [String] fields
Selector specifying which fields to include in a partial response.
@param [String] #quota_user
Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. Overrides userIp if both are provided.
@param [String] #user_ip
IP address of the site where the request originates. Use this if you want to enforce per-user limits.
@param [Google::Apis::RequestOptions] options
Request-specific options
@yield [result, err] Result & error if block supplied @yieldparam result [Google::Apis::CoordinateV1::Schedule] parsed result object @yieldparam err [StandardError] error object if request failed
@return [Google::Apis::CoordinateV1::Schedule]
@raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification @raise [Google::Apis::AuthorizationError] Authorization is required
# File generated/google/apis/coordinate_v1/service.rb, line 471 def get_schedule(team_id, job_id, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) command = make_simple_command(:get, 'teams/{teamId}/jobs/{jobId}/schedule', options) command.response_representation = Google::Apis::CoordinateV1::Schedule::Representation command.response_class = Google::Apis::CoordinateV1::Schedule command.params['teamId'] = team_id unless team_id.nil? command.params['jobId'] = job_id unless job_id.nil? command.query['fields'] = fields unless fields.nil? command.query['quotaUser'] = quota_user unless quota_user.nil? command.query['userIp'] = user_ip unless user_ip.nil? execute_or_queue_command(command, &block) end
Inserts a new job. Only the state field of the job should be set. @param [String] team_id
Team ID
@param [String] address
Job address as newline (Unix) separated string
@param [Float] lat
The latitude coordinate of this job's location.
@param [Float] lng
The longitude coordinate of this job's location.
@param [String] title
Job title
@param [Google::Apis::CoordinateV1::Job] job_object @param [String] assignee
Assignee email address, or empty string to unassign.
@param [Array<String>, String] custom_field
Sets the value of custom fields. To set a custom field, pass the field id ( from /team/teamId/custom_fields), a URL escaped '=' character, and the desired value as a parameter. For example, customField=12%3DAlice. Repeat the parameter for each custom field. Note that '=' cannot appear in the parameter value. Specifying an invalid, or inactive enum field will result in an error 500.
@param [String] customer_name
Customer name
@param [String] customer_phone_number
Customer phone number
@param [String] note
Job note as newline (Unix) separated string
@param [String] fields
Selector specifying which fields to include in a partial response.
@param [String] #quota_user
Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. Overrides userIp if both are provided.
@param [String] #user_ip
IP address of the site where the request originates. Use this if you want to enforce per-user limits.
@param [Google::Apis::RequestOptions] options
Request-specific options
@yield [result, err] Result & error if block supplied @yieldparam result [Google::Apis::CoordinateV1::Job] parsed result object @yieldparam err [StandardError] error object if request failed
@return [Google::Apis::CoordinateV1::Job]
@raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification @raise [Google::Apis::AuthorizationError] Authorization is required
# File generated/google/apis/coordinate_v1/service.rb, line 176 def insert_job(team_id, address, lat, lng, title, job_object = nil, assignee: nil, custom_field: nil, customer_name: nil, customer_phone_number: nil, note: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) command = make_simple_command(:post, 'teams/{teamId}/jobs', options) command.request_representation = Google::Apis::CoordinateV1::Job::Representation command.request_object = job_object command.response_representation = Google::Apis::CoordinateV1::Job::Representation command.response_class = Google::Apis::CoordinateV1::Job command.params['teamId'] = team_id unless team_id.nil? command.query['address'] = address unless address.nil? command.query['assignee'] = assignee unless assignee.nil? command.query['customField'] = custom_field unless custom_field.nil? command.query['customerName'] = customer_name unless customer_name.nil? command.query['customerPhoneNumber'] = customer_phone_number unless customer_phone_number.nil? command.query['lat'] = lat unless lat.nil? command.query['lng'] = lng unless lng.nil? command.query['note'] = note unless note.nil? command.query['title'] = title unless title.nil? command.query['fields'] = fields unless fields.nil? command.query['quotaUser'] = quota_user unless quota_user.nil? command.query['userIp'] = user_ip unless user_ip.nil? execute_or_queue_command(command, &block) end
Retrieves a list of custom field definitions for a team. @param [String] team_id
Team ID
@param [String] fields
Selector specifying which fields to include in a partial response.
@param [String] #quota_user
Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. Overrides userIp if both are provided.
@param [String] #user_ip
IP address of the site where the request originates. Use this if you want to enforce per-user limits.
@param [Google::Apis::RequestOptions] options
Request-specific options
@yield [result, err] Result & error if block supplied @yieldparam result [Google::Apis::CoordinateV1::ListCustomFieldDefResponse] parsed result object @yieldparam err [StandardError] error object if request failed
@return [Google::Apis::CoordinateV1::ListCustomFieldDefResponse]
@raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification @raise [Google::Apis::AuthorizationError] Authorization is required
# File generated/google/apis/coordinate_v1/service.rb, line 79 def list_custom_field_defs(team_id, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) command = make_simple_command(:get, 'teams/{teamId}/custom_fields', options) command.response_representation = Google::Apis::CoordinateV1::ListCustomFieldDefResponse::Representation command.response_class = Google::Apis::CoordinateV1::ListCustomFieldDefResponse command.params['teamId'] = team_id unless team_id.nil? command.query['fields'] = fields unless fields.nil? command.query['quotaUser'] = quota_user unless quota_user.nil? command.query['userIp'] = user_ip unless user_ip.nil? execute_or_queue_command(command, &block) end
Retrieves jobs created or modified since the given timestamp. @param [String] team_id
Team ID
@param [Fixnum] max_results
Maximum number of results to return in one page.
@param [String] min_modified_timestamp_ms
Minimum time a job was modified in milliseconds since epoch.
@param [Boolean] omit_job_changes
Whether to omit detail job history information.
@param [String] page_token
Continuation token
@param [String] fields
Selector specifying which fields to include in a partial response.
@param [String] #quota_user
Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. Overrides userIp if both are provided.
@param [String] #user_ip
IP address of the site where the request originates. Use this if you want to enforce per-user limits.
@param [Google::Apis::RequestOptions] options
Request-specific options
@yield [result, err] Result & error if block supplied @yieldparam result [Google::Apis::CoordinateV1::ListJobResponse] parsed result object @yieldparam err [StandardError] error object if request failed
@return [Google::Apis::CoordinateV1::ListJobResponse]
@raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification @raise [Google::Apis::AuthorizationError] Authorization is required
# File generated/google/apis/coordinate_v1/service.rb, line 230 def list_jobs(team_id, max_results: nil, min_modified_timestamp_ms: nil, omit_job_changes: nil, page_token: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) command = make_simple_command(:get, 'teams/{teamId}/jobs', options) command.response_representation = Google::Apis::CoordinateV1::ListJobResponse::Representation command.response_class = Google::Apis::CoordinateV1::ListJobResponse command.params['teamId'] = team_id unless team_id.nil? command.query['maxResults'] = max_results unless max_results.nil? command.query['minModifiedTimestampMs'] = min_modified_timestamp_ms unless min_modified_timestamp_ms.nil? command.query['omitJobChanges'] = omit_job_changes unless omit_job_changes.nil? command.query['pageToken'] = page_token unless page_token.nil? command.query['fields'] = fields unless fields.nil? command.query['quotaUser'] = quota_user unless quota_user.nil? command.query['userIp'] = user_ip unless user_ip.nil? execute_or_queue_command(command, &block) end
Retrieves a list of locations for a worker. @param [String] team_id
Team ID
@param [String] worker_email
Worker email address.
@param [String] start_timestamp_ms
Start timestamp in milliseconds since the epoch.
@param [Fixnum] max_results
Maximum number of results to return in one page.
@param [String] page_token
Continuation token
@param [String] fields
Selector specifying which fields to include in a partial response.
@param [String] #quota_user
Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. Overrides userIp if both are provided.
@param [String] #user_ip
IP address of the site where the request originates. Use this if you want to enforce per-user limits.
@param [Google::Apis::RequestOptions] options
Request-specific options
@yield [result, err] Result & error if block supplied @yieldparam result [Google::Apis::CoordinateV1::ListLocationResponse] parsed result object @yieldparam err [StandardError] error object if request failed
@return [Google::Apis::CoordinateV1::ListLocationResponse]
@raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification @raise [Google::Apis::AuthorizationError] Authorization is required
# File generated/google/apis/coordinate_v1/service.rb, line 430 def list_locations(team_id, worker_email, start_timestamp_ms, max_results: nil, page_token: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) command = make_simple_command(:get, 'teams/{teamId}/workers/{workerEmail}/locations', options) command.response_representation = Google::Apis::CoordinateV1::ListLocationResponse::Representation command.response_class = Google::Apis::CoordinateV1::ListLocationResponse command.params['teamId'] = team_id unless team_id.nil? command.params['workerEmail'] = worker_email unless worker_email.nil? command.query['maxResults'] = max_results unless max_results.nil? command.query['pageToken'] = page_token unless page_token.nil? command.query['startTimestampMs'] = start_timestamp_ms unless start_timestamp_ms.nil? command.query['fields'] = fields unless fields.nil? command.query['quotaUser'] = quota_user unless quota_user.nil? command.query['userIp'] = user_ip unless user_ip.nil? execute_or_queue_command(command, &block) end
Retrieves a list of teams for a user. @param [Boolean] admin
Whether to include teams for which the user has the Admin role.
@param [Boolean] dispatcher
Whether to include teams for which the user has the Dispatcher role.
@param [Boolean] worker
Whether to include teams for which the user has the Worker role.
@param [String] fields
Selector specifying which fields to include in a partial response.
@param [String] #quota_user
Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. Overrides userIp if both are provided.
@param [String] #user_ip
IP address of the site where the request originates. Use this if you want to enforce per-user limits.
@param [Google::Apis::RequestOptions] options
Request-specific options
@yield [result, err] Result & error if block supplied @yieldparam result [Google::Apis::CoordinateV1::ListTeamResponse] parsed result object @yieldparam err [StandardError] error object if request failed
@return [Google::Apis::CoordinateV1::ListTeamResponse]
@raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification @raise [Google::Apis::AuthorizationError] Authorization is required
# File generated/google/apis/coordinate_v1/service.rb, line 620 def list_teams(admin: nil, dispatcher: nil, worker: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) command = make_simple_command(:get, 'teams', options) command.response_representation = Google::Apis::CoordinateV1::ListTeamResponse::Representation command.response_class = Google::Apis::CoordinateV1::ListTeamResponse command.query['admin'] = admin unless admin.nil? command.query['dispatcher'] = dispatcher unless dispatcher.nil? command.query['worker'] = worker unless worker.nil? command.query['fields'] = fields unless fields.nil? command.query['quotaUser'] = quota_user unless quota_user.nil? command.query['userIp'] = user_ip unless user_ip.nil? execute_or_queue_command(command, &block) end
Retrieves a list of workers in a team. @param [String] team_id
Team ID
@param [String] fields
Selector specifying which fields to include in a partial response.
@param [String] #quota_user
Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. Overrides userIp if both are provided.
@param [String] #user_ip
IP address of the site where the request originates. Use this if you want to enforce per-user limits.
@param [Google::Apis::RequestOptions] options
Request-specific options
@yield [result, err] Result & error if block supplied @yieldparam result [Google::Apis::CoordinateV1::ListWorkerResponse] parsed result object @yieldparam err [StandardError] error object if request failed
@return [Google::Apis::CoordinateV1::ListWorkerResponse]
@raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification @raise [Google::Apis::AuthorizationError] Authorization is required
# File generated/google/apis/coordinate_v1/service.rb, line 657 def list_workers(team_id, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) command = make_simple_command(:get, 'teams/{teamId}/workers', options) command.response_representation = Google::Apis::CoordinateV1::ListWorkerResponse::Representation command.response_class = Google::Apis::CoordinateV1::ListWorkerResponse command.params['teamId'] = team_id unless team_id.nil? command.query['fields'] = fields unless fields.nil? command.query['quotaUser'] = quota_user unless quota_user.nil? command.query['userIp'] = user_ip unless user_ip.nil? execute_or_queue_command(command, &block) end
Updates a job. Fields that are set in the job state will be updated. This method supports patch semantics. @param [String] team_id
Team ID
@param [String] job_id
Job number
@param [Google::Apis::CoordinateV1::Job] job_object @param [String] address
Job address as newline (Unix) separated string
@param [String] assignee
Assignee email address, or empty string to unassign.
@param [Array<String>, String] custom_field
Sets the value of custom fields. To set a custom field, pass the field id ( from /team/teamId/custom_fields), a URL escaped '=' character, and the desired value as a parameter. For example, customField=12%3DAlice. Repeat the parameter for each custom field. Note that '=' cannot appear in the parameter value. Specifying an invalid, or inactive enum field will result in an error 500.
@param [String] customer_name
Customer name
@param [String] customer_phone_number
Customer phone number
@param [Float] lat
The latitude coordinate of this job's location.
@param [Float] lng
The longitude coordinate of this job's location.
@param [String] note
Job note as newline (Unix) separated string
@param [String] progress
Job progress
@param [String] title
Job title
@param [String] fields
Selector specifying which fields to include in a partial response.
@param [String] #quota_user
Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. Overrides userIp if both are provided.
@param [String] #user_ip
IP address of the site where the request originates. Use this if you want to enforce per-user limits.
@param [Google::Apis::RequestOptions] options
Request-specific options
@yield [result, err] Result & error if block supplied @yieldparam result [Google::Apis::CoordinateV1::Job] parsed result object @yieldparam err [StandardError] error object if request failed
@return [Google::Apis::CoordinateV1::Job]
@raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification @raise [Google::Apis::AuthorizationError] Authorization is required
# File generated/google/apis/coordinate_v1/service.rb, line 298 def patch_job(team_id, job_id, job_object = nil, address: nil, assignee: nil, custom_field: nil, customer_name: nil, customer_phone_number: nil, lat: nil, lng: nil, note: nil, progress: nil, title: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) command = make_simple_command(:patch, 'teams/{teamId}/jobs/{jobId}', options) command.request_representation = Google::Apis::CoordinateV1::Job::Representation command.request_object = job_object command.response_representation = Google::Apis::CoordinateV1::Job::Representation command.response_class = Google::Apis::CoordinateV1::Job command.params['teamId'] = team_id unless team_id.nil? command.params['jobId'] = job_id unless job_id.nil? command.query['address'] = address unless address.nil? command.query['assignee'] = assignee unless assignee.nil? command.query['customField'] = custom_field unless custom_field.nil? command.query['customerName'] = customer_name unless customer_name.nil? command.query['customerPhoneNumber'] = customer_phone_number unless customer_phone_number.nil? command.query['lat'] = lat unless lat.nil? command.query['lng'] = lng unless lng.nil? command.query['note'] = note unless note.nil? command.query['progress'] = progress unless progress.nil? command.query['title'] = title unless title.nil? command.query['fields'] = fields unless fields.nil? command.query['quotaUser'] = quota_user unless quota_user.nil? command.query['userIp'] = user_ip unless user_ip.nil? execute_or_queue_command(command, &block) end
Replaces the schedule of a job with the provided schedule. This method supports patch semantics. @param [String] team_id
Team ID
@param [String] job_id
Job number
@param [Google::Apis::CoordinateV1::Schedule] schedule_object @param [Boolean] all_day
Whether the job is scheduled for the whole day. Time of day in start/end times is ignored if this is true.
@param [String] duration
Job duration in milliseconds.
@param [String] end_time
Scheduled end time in milliseconds since epoch.
@param [String] start_time
Scheduled start time in milliseconds since epoch.
@param [String] fields
Selector specifying which fields to include in a partial response.
@param [String] #quota_user
Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. Overrides userIp if both are provided.
@param [String] #user_ip
IP address of the site where the request originates. Use this if you want to enforce per-user limits.
@param [Google::Apis::RequestOptions] options
Request-specific options
@yield [result, err] Result & error if block supplied @yieldparam result [Google::Apis::CoordinateV1::Schedule] parsed result object @yieldparam err [StandardError] error object if request failed
@return [Google::Apis::CoordinateV1::Schedule]
@raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification @raise [Google::Apis::AuthorizationError] Authorization is required
# File generated/google/apis/coordinate_v1/service.rb, line 520 def patch_schedule(team_id, job_id, schedule_object = nil, all_day: nil, duration: nil, end_time: nil, start_time: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) command = make_simple_command(:patch, 'teams/{teamId}/jobs/{jobId}/schedule', options) command.request_representation = Google::Apis::CoordinateV1::Schedule::Representation command.request_object = schedule_object command.response_representation = Google::Apis::CoordinateV1::Schedule::Representation command.response_class = Google::Apis::CoordinateV1::Schedule command.params['teamId'] = team_id unless team_id.nil? command.params['jobId'] = job_id unless job_id.nil? command.query['allDay'] = all_day unless all_day.nil? command.query['duration'] = duration unless duration.nil? command.query['endTime'] = end_time unless end_time.nil? command.query['startTime'] = start_time unless start_time.nil? command.query['fields'] = fields unless fields.nil? command.query['quotaUser'] = quota_user unless quota_user.nil? command.query['userIp'] = user_ip unless user_ip.nil? execute_or_queue_command(command, &block) end
Updates a job. Fields that are set in the job state will be updated. @param [String] team_id
Team ID
@param [String] job_id
Job number
@param [Google::Apis::CoordinateV1::Job] job_object @param [String] address
Job address as newline (Unix) separated string
@param [String] assignee
Assignee email address, or empty string to unassign.
@param [Array<String>, String] custom_field
Sets the value of custom fields. To set a custom field, pass the field id ( from /team/teamId/custom_fields), a URL escaped '=' character, and the desired value as a parameter. For example, customField=12%3DAlice. Repeat the parameter for each custom field. Note that '=' cannot appear in the parameter value. Specifying an invalid, or inactive enum field will result in an error 500.
@param [String] customer_name
Customer name
@param [String] customer_phone_number
Customer phone number
@param [Float] lat
The latitude coordinate of this job's location.
@param [Float] lng
The longitude coordinate of this job's location.
@param [String] note
Job note as newline (Unix) separated string
@param [String] progress
Job progress
@param [String] title
Job title
@param [String] fields
Selector specifying which fields to include in a partial response.
@param [String] #quota_user
Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. Overrides userIp if both are provided.
@param [String] #user_ip
IP address of the site where the request originates. Use this if you want to enforce per-user limits.
@param [Google::Apis::RequestOptions] options
Request-specific options
@yield [result, err] Result & error if block supplied @yieldparam result [Google::Apis::CoordinateV1::Job] parsed result object @yieldparam err [StandardError] error object if request failed
@return [Google::Apis::CoordinateV1::Job]
@raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification @raise [Google::Apis::AuthorizationError] Authorization is required
# File generated/google/apis/coordinate_v1/service.rb, line 374 def update_job(team_id, job_id, job_object = nil, address: nil, assignee: nil, custom_field: nil, customer_name: nil, customer_phone_number: nil, lat: nil, lng: nil, note: nil, progress: nil, title: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) command = make_simple_command(:put, 'teams/{teamId}/jobs/{jobId}', options) command.request_representation = Google::Apis::CoordinateV1::Job::Representation command.request_object = job_object command.response_representation = Google::Apis::CoordinateV1::Job::Representation command.response_class = Google::Apis::CoordinateV1::Job command.params['teamId'] = team_id unless team_id.nil? command.params['jobId'] = job_id unless job_id.nil? command.query['address'] = address unless address.nil? command.query['assignee'] = assignee unless assignee.nil? command.query['customField'] = custom_field unless custom_field.nil? command.query['customerName'] = customer_name unless customer_name.nil? command.query['customerPhoneNumber'] = customer_phone_number unless customer_phone_number.nil? command.query['lat'] = lat unless lat.nil? command.query['lng'] = lng unless lng.nil? command.query['note'] = note unless note.nil? command.query['progress'] = progress unless progress.nil? command.query['title'] = title unless title.nil? command.query['fields'] = fields unless fields.nil? command.query['quotaUser'] = quota_user unless quota_user.nil? command.query['userIp'] = user_ip unless user_ip.nil? execute_or_queue_command(command, &block) end
Replaces the schedule of a job with the provided schedule. @param [String] team_id
Team ID
@param [String] job_id
Job number
@param [Google::Apis::CoordinateV1::Schedule] schedule_object @param [Boolean] all_day
Whether the job is scheduled for the whole day. Time of day in start/end times is ignored if this is true.
@param [String] duration
Job duration in milliseconds.
@param [String] end_time
Scheduled end time in milliseconds since epoch.
@param [String] start_time
Scheduled start time in milliseconds since epoch.
@param [String] fields
Selector specifying which fields to include in a partial response.
@param [String] #quota_user
Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. Overrides userIp if both are provided.
@param [String] #user_ip
IP address of the site where the request originates. Use this if you want to enforce per-user limits.
@param [Google::Apis::RequestOptions] options
Request-specific options
@yield [result, err] Result & error if block supplied @yieldparam result [Google::Apis::CoordinateV1::Schedule] parsed result object @yieldparam err [StandardError] error object if request failed
@return [Google::Apis::CoordinateV1::Schedule]
@raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification @raise [Google::Apis::AuthorizationError] Authorization is required
# File generated/google/apis/coordinate_v1/service.rb, line 574 def update_schedule(team_id, job_id, schedule_object = nil, all_day: nil, duration: nil, end_time: nil, start_time: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) command = make_simple_command(:put, 'teams/{teamId}/jobs/{jobId}/schedule', options) command.request_representation = Google::Apis::CoordinateV1::Schedule::Representation command.request_object = schedule_object command.response_representation = Google::Apis::CoordinateV1::Schedule::Representation command.response_class = Google::Apis::CoordinateV1::Schedule command.params['teamId'] = team_id unless team_id.nil? command.params['jobId'] = job_id unless job_id.nil? command.query['allDay'] = all_day unless all_day.nil? command.query['duration'] = duration unless duration.nil? command.query['endTime'] = end_time unless end_time.nil? command.query['startTime'] = start_time unless start_time.nil? command.query['fields'] = fields unless fields.nil? command.query['quotaUser'] = quota_user unless quota_user.nil? command.query['userIp'] = user_ip unless user_ip.nil? execute_or_queue_command(command, &block) end
Protected Instance Methods
# File generated/google/apis/coordinate_v1/service.rb, line 670 def apply_command_defaults(command) command.query['key'] = key unless key.nil? command.query['quotaUser'] = quota_user unless quota_user.nil? command.query['userIp'] = user_ip unless user_ip.nil? end