Viewing file:  ProjectsLocationsStreams.php (7.42 KB) -rw-r--r--
Select action/file-type:
 (+) |  (+) |  (+) | Code (+) | Session (+) |  (+) | SDB (+) |  (+) |  (+) |  (+) |  (+) |  (+) |
<?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\Datastream\Resource;
use Google\Service\Datastream\ListStreamsResponse;
use Google\Service\Datastream\Operation;
use Google\Service\Datastream\Stream;
/**
* The "streams" collection of methods.
* Typical usage is:
* <code>
* $datastreamService = new Google\Service\Datastream(...);
* $streams = $datastreamService->projects_locations_streams;
* </code>
*/
class ProjectsLocationsStreams extends \Google\Service\Resource
{
/**
* Use this method to create a stream. (streams.create)
*
* @param string $parent Required. The parent that owns the collection of
* streams.
* @param Stream $postBody
* @param array $optParams Optional parameters.
*
* @opt_param bool force Optional. Create the stream without validating it.
* @opt_param string requestId Optional. A request ID to identify requests.
* Specify a unique request ID so that if you must retry your request, the
* server will know to ignore the request if it has already been completed. The
* server will guarantee that for at least 60 minutes since the first request.
* For example, consider a situation where you make an initial request and the
* request times out. If you make the request again with the same request ID,
* the server can check if original operation with the same request ID was
* received, and if so, will ignore the second request. This prevents clients
* from accidentally creating duplicate commitments. The request ID must be a
* valid UUID with the exception that zero UUID is not supported
* (00000000-0000-0000-0000-000000000000).
* @opt_param string streamId Required. The stream identifier.
* @opt_param bool validateOnly Optional. Only validate the stream, but don't
* create any resources. The default is false.
* @return Operation
*/
public function create($parent, Stream $postBody, $optParams = [])
{
$params = ['parent' => $parent, 'postBody' => $postBody];
$params = array_merge($params, $optParams);
return $this->call('create', [$params], Operation::class);
}
/**
* Use this method to delete a stream. (streams.delete)
*
* @param string $name Required. The name of the stream resource to delete.
* @param array $optParams Optional parameters.
*
* @opt_param string requestId Optional. A request ID to identify requests.
* Specify a unique request ID so that if you must retry your request, the
* server will know to ignore the request if it has already been completed. The
* server will guarantee that for at least 60 minutes after the first request.
* For example, consider a situation where you make an initial request and the
* request times out. If you make the request again with the same request ID,
* the server can check if original operation with the same request ID was
* received, and if so, will ignore the second request. This prevents clients
* from accidentally creating duplicate commitments. The request ID must be a
* valid UUID with the exception that zero UUID is not supported
* (00000000-0000-0000-0000-000000000000).
* @return Operation
*/
public function delete($name, $optParams = [])
{
$params = ['name' => $name];
$params = array_merge($params, $optParams);
return $this->call('delete', [$params], Operation::class);
}
/**
* Use this method to get details about a stream. (streams.get)
*
* @param string $name Required. The name of the stream resource to get.
* @param array $optParams Optional parameters.
* @return Stream
*/
public function get($name, $optParams = [])
{
$params = ['name' => $name];
$params = array_merge($params, $optParams);
return $this->call('get', [$params], Stream::class);
}
/**
* Use this method to list streams in a project and location.
* (streams.listProjectsLocationsStreams)
*
* @param string $parent Required. The parent that owns the collection of
* streams.
* @param array $optParams Optional parameters.
*
* @opt_param string filter Filter request.
* @opt_param string orderBy Order by fields for the result.
* @opt_param int pageSize Maximum number of streams to return. If unspecified,
* at most 50 streams will be returned. The maximum value is 1000; values above
* 1000 will be coerced to 1000.
* @opt_param string pageToken Page token received from a previous `ListStreams`
* call. Provide this to retrieve the subsequent page. When paginating, all
* other parameters provided to `ListStreams` must match the call that provided
* the page token.
* @return ListStreamsResponse
*/
public function listProjectsLocationsStreams($parent, $optParams = [])
{
$params = ['parent' => $parent];
$params = array_merge($params, $optParams);
return $this->call('list', [$params], ListStreamsResponse::class);
}
/**
* Use this method to update the configuration of a stream. (streams.patch)
*
* @param string $name Output only. The stream's name.
* @param Stream $postBody
* @param array $optParams Optional parameters.
*
* @opt_param bool force Optional. Update the stream without validating it.
* @opt_param string requestId Optional. A request ID to identify requests.
* Specify a unique request ID so that if you must retry your request, the
* server will know to ignore the request if it has already been completed. The
* server will guarantee that for at least 60 minutes since the first request.
* For example, consider a situation where you make an initial request and the
* request times out. If you make the request again with the same request ID,
* the server can check if original operation with the same request ID was
* received, and if so, will ignore the second request. This prevents clients
* from accidentally creating duplicate commitments. The request ID must be a
* valid UUID with the exception that zero UUID is not supported
* (00000000-0000-0000-0000-000000000000).
* @opt_param string updateMask Optional. Field mask is used to specify the
* fields to be overwritten in the stream resource by the update. The fields
* specified in the update_mask are relative to the resource, not the full
* request. A field will be overwritten if it is in the mask. If the user does
* not provide a mask then all fields will be overwritten.
* @opt_param bool validateOnly Optional. Only validate the stream with the
* changes, without actually updating it. The default is false.
* @return Operation
*/
public function patch($name, Stream $postBody, $optParams = [])
{
$params = ['name' => $name, 'postBody' => $postBody];
$params = array_merge($params, $optParams);
return $this->call('patch', [$params], Operation::class);
}
}
// Adding a class alias for backwards compatibility with the previous class name.
class_alias(ProjectsLocationsStreams::class, 'Google_Service_Datastream_Resource_ProjectsLocationsStreams');
|