File "ProjectsJobsMessages.php"
Full Path: /home/palsarh/web/palsarh.in/public_html/vendor/google/apiclient-services/src/Dataflow/Resource/ProjectsJobsMessages.php
File size: 3.03 KB
MIME-type: text/x-php
Charset: utf-8
<?php
/*
* Copyright 2014 Google Inc.
*
* Licensed under the Apache License, Version 2.0 (the "License"); you may not
* use this file except in compliance with the License. You may obtain a copy of
* the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS, WITHOUT
* WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the
* License for the specific language governing permissions and limitations under
* the License.
*/
namespace Google\Service\Dataflow\Resource;
use Google\Service\Dataflow\ListJobMessagesResponse;
/**
* The "messages" collection of methods.
* Typical usage is:
* <code>
* $dataflowService = new Google\Service\Dataflow(...);
* $messages = $dataflowService->projects_jobs_messages;
* </code>
*/
class ProjectsJobsMessages extends \Google\Service\Resource
{
/**
* Request the job status. To request the status of a job, we recommend using
* `projects.locations.jobs.messages.list` with a [regional endpoint]
* (https://cloud.google.com/dataflow/docs/concepts/regional-endpoints). Using
* `projects.jobs.messages.list` is not recommended, as you can only request the
* status of jobs that are running in `us-central1`.
* (messages.listProjectsJobsMessages)
*
* @param string $projectId A project id.
* @param string $jobId The job to get messages about.
* @param array $optParams Optional parameters.
*
* @opt_param string endTime Return only messages with timestamps < end_time.
* The default is now (i.e. return up to the latest messages available).
* @opt_param string location The [regional endpoint]
* (https://cloud.google.com/dataflow/docs/concepts/regional-endpoints) that
* contains the job specified by job_id.
* @opt_param string minimumImportance Filter to only get messages with
* importance >= level
* @opt_param int pageSize If specified, determines the maximum number of
* messages to return. If unspecified, the service may choose an appropriate
* default, or may return an arbitrarily large number of results.
* @opt_param string pageToken If supplied, this should be the value of
* next_page_token returned by an earlier call. This will cause the next page of
* results to be returned.
* @opt_param string startTime If specified, return only messages with
* timestamps >= start_time. The default is the job creation time (i.e.
* beginning of messages).
* @return ListJobMessagesResponse
* @throws \Google\Service\Exception
*/
public function listProjectsJobsMessages($projectId, $jobId, $optParams = [])
{
$params = ['projectId' => $projectId, 'jobId' => $jobId];
$params = array_merge($params, $optParams);
return $this->call('list', [$params], ListJobMessagesResponse::class);
}
}
// Adding a class alias for backwards compatibility with the previous class name.
class_alias(ProjectsJobsMessages::class, 'Google_Service_Dataflow_Resource_ProjectsJobsMessages');