Current File : /home/graphicd/www/vebto/vendor/google/apiclient-services/src/CloudSupport/Resource/Cases.php
<?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\CloudSupport\Resource;
use Google\Service\CloudSupport\CloseCaseRequest;
use Google\Service\CloudSupport\CloudsupportCase;
use Google\Service\CloudSupport\EscalateCaseRequest;
use Google\Service\CloudSupport\ListCasesResponse;
use Google\Service\CloudSupport\SearchCasesResponse;
/**
* The "cases" collection of methods.
* Typical usage is:
* <code>
* $cloudsupportService = new Google\Service\CloudSupport(...);
* $cases = $cloudsupportService->cases;
* </code>
*/
class Cases extends \Google\Service\Resource
{
/**
* Close the specified case. (cases.close)
*
* @param string $name Required. The fully qualified name of the case resource
* to be closed.
* @param CloseCaseRequest $postBody
* @param array $optParams Optional parameters.
* @return CloudsupportCase
*/
public function close($name, CloseCaseRequest $postBody, $optParams = [])
{
$params = ['name' => $name, 'postBody' => $postBody];
$params = array_merge($params, $optParams);
return $this->call('close', [$params], CloudsupportCase::class);
}
/**
* Create a new case and associate it with the given Cloud resource.
* (cases.create)
*
* @param string $parent Required. The name of the Cloud resource under which
* the case should be created.
* @param CloudsupportCase $postBody
* @param array $optParams Optional parameters.
* @return CloudsupportCase
*/
public function create($parent, CloudsupportCase $postBody, $optParams = [])
{
$params = ['parent' => $parent, 'postBody' => $postBody];
$params = array_merge($params, $optParams);
return $this->call('create', [$params], CloudsupportCase::class);
}
/**
* Escalate a case. Escalating a case will initiate the Cloud Support escalation
* management process. This operation is only available to certain Customer Care
* tiers. Go to https://cloud.google.com/support and look for 'Technical support
* escalations' in the feature list to find out which tiers are able to perform
* escalations. (cases.escalate)
*
* @param string $name Required. The fully qualified name of the Case resource
* to be escalated.
* @param EscalateCaseRequest $postBody
* @param array $optParams Optional parameters.
* @return CloudsupportCase
*/
public function escalate($name, EscalateCaseRequest $postBody, $optParams = [])
{
$params = ['name' => $name, 'postBody' => $postBody];
$params = array_merge($params, $optParams);
return $this->call('escalate', [$params], CloudsupportCase::class);
}
/**
* Retrieve the specified case. (cases.get)
*
* @param string $name Required. The fully qualified name of a case to be
* retrieved.
* @param array $optParams Optional parameters.
* @return CloudsupportCase
*/
public function get($name, $optParams = [])
{
$params = ['name' => $name];
$params = array_merge($params, $optParams);
return $this->call('get', [$params], CloudsupportCase::class);
}
/**
* Retrieve all cases under the specified parent. (cases.listCases)
*
* @param string $parent Required. The fully qualified name of parent resource
* to list cases under.
* @param array $optParams Optional parameters.
*
* @opt_param string filter An expression written in the Cloud filter language.
* If non-empty, then only cases whose fields match the filter are returned. If
* empty, then no messages are filtered out. Filter strings can use the
* following fields: - status (Accepted values: OPEN or CLOSED) - severity
* (Accepted values: S0, S1, S2, S3, or S4) - creator.email with the operators
* equals (=) and AND. Additionally, a global restriction (with no operator) can
* be used to search across displayName, description, and comments (e.g. "my
* search").
* @opt_param string orderBy A comma separated list of fields to order by,
* followed by `asc` or `desc` postfix. This list is case-insensitive, default
* sorting order is ascending, redundant space characters are insignificant.
* Example: `name asc,update_time, create_time desc`
* @opt_param int pageSize The maximum number of cases fetched with each
* request. Defaults to 10.
* @opt_param string pageToken A token identifying the page of results to
* return. If unspecified, the first page is retrieved.
* @return ListCasesResponse
*/
public function listCases($parent, $optParams = [])
{
$params = ['parent' => $parent];
$params = array_merge($params, $optParams);
return $this->call('list', [$params], ListCasesResponse::class);
}
/**
* Update the specified case. Only a subset of fields (display_name,
* description, time_zone, subscriber_email_addresses, related_resources,
* severity, primary_contact, and labels) can be updated. (cases.patch)
*
* @param string $name The resource name for the case.
* @param CloudsupportCase $postBody
* @param array $optParams Optional parameters.
*
* @opt_param string updateMask A field that represents attributes of a case
* object that should be updated as part of this request. Supported values are
* severity, display_name, and subscriber_email_addresses. If no fields are
* specified, all supported fields will be updated. WARNING: If you do not
* provide a field mask then you may accidentally clear some fields. For
* example, if you leave field mask empty and do not provide a value for
* subscriber_email_addresses then subscriber_email_addresses will be updated to
* empty.
* @return CloudsupportCase
*/
public function patch($name, CloudsupportCase $postBody, $optParams = [])
{
$params = ['name' => $name, 'postBody' => $postBody];
$params = array_merge($params, $optParams);
return $this->call('patch', [$params], CloudsupportCase::class);
}
/**
* Search cases using the specified query. (cases.search)
*
* @param array $optParams Optional parameters.
*
* @opt_param int pageSize The maximum number of cases fetched with each
* request. The default page size is 10.
* @opt_param string pageToken A token identifying the page of results to
* return. If unspecified, the first page is retrieved.
* @opt_param string query An expression written in the Cloud filter language.
* Filter strings can use the following fields: - organization (A name of the
* form organizations/) - project (A name of the form projects/) - customer (A
* name of the form customers/) - state (Accepted values: OPEN or CLOSED) -
* severity (Accepted values: S0, S1, S2, S3, or S4) - creator.email with the
* operators equals (=) and AND. Additionally, a global restriction (with no
* key/operator) can be used to search across display_name, description, and
* comments (e.g. "my search"). One of organization, project, or customer field
* must be specified.
* @return SearchCasesResponse
*/
public function search($optParams = [])
{
$params = [];
$params = array_merge($params, $optParams);
return $this->call('search', [$params], SearchCasesResponse::class);
}
}
// Adding a class alias for backwards compatibility with the previous class name.
class_alias(Cases::class, 'Google_Service_CloudSupport_Resource_Cases');
Mini Shell