code
stringlengths 17
296k
| docstring
stringlengths 30
30.3k
| func_name
stringlengths 1
89
| language
stringclasses 1
value | repo
stringlengths 7
63
| path
stringlengths 7
153
| url
stringlengths 51
209
| license
stringclasses 4
values |
|---|---|---|---|---|---|---|---|
public function setNodePoolId($var)
{
@trigger_error('node_pool_id is deprecated.', E_USER_DEPRECATED);
GPBUtil::checkString($var, True);
$this->node_pool_id = $var;
return $this;
} | Deprecated. The name of the node pool to update.
This field has been deprecated and replaced by the name field.
Generated from protobuf field <code>string node_pool_id = 4 [deprecated = true];</code>
@param string $var
@return $this
@deprecated | setNodePoolId | php | googleapis/google-cloud-php | Container/src/V1/SetNodePoolManagementRequest.php | https://github.com/googleapis/google-cloud-php/blob/master/Container/src/V1/SetNodePoolManagementRequest.php | Apache-2.0 |
public function getManagement()
{
return $this->management;
} | Required. NodeManagement configuration for the node pool.
Generated from protobuf field <code>.google.container.v1.NodeManagement management = 5 [(.google.api.field_behavior) = REQUIRED];</code>
@return \Google\Cloud\Container\V1\NodeManagement|null | getManagement | php | googleapis/google-cloud-php | Container/src/V1/SetNodePoolManagementRequest.php | https://github.com/googleapis/google-cloud-php/blob/master/Container/src/V1/SetNodePoolManagementRequest.php | Apache-2.0 |
public function setManagement($var)
{
GPBUtil::checkMessage($var, \Google\Cloud\Container\V1\NodeManagement::class);
$this->management = $var;
return $this;
} | Required. NodeManagement configuration for the node pool.
Generated from protobuf field <code>.google.container.v1.NodeManagement management = 5 [(.google.api.field_behavior) = REQUIRED];</code>
@param \Google\Cloud\Container\V1\NodeManagement $var
@return $this | setManagement | php | googleapis/google-cloud-php | Container/src/V1/SetNodePoolManagementRequest.php | https://github.com/googleapis/google-cloud-php/blob/master/Container/src/V1/SetNodePoolManagementRequest.php | Apache-2.0 |
public function getName()
{
return $this->name;
} | The name (project, location, cluster, node pool id) of the node pool to set
management properties. Specified in the format
`projects/*/locations/*/clusters/*/nodePools/*`.
Generated from protobuf field <code>string name = 7;</code>
@return string | getName | php | googleapis/google-cloud-php | Container/src/V1/SetNodePoolManagementRequest.php | https://github.com/googleapis/google-cloud-php/blob/master/Container/src/V1/SetNodePoolManagementRequest.php | Apache-2.0 |
public function setName($var)
{
GPBUtil::checkString($var, True);
$this->name = $var;
return $this;
} | The name (project, location, cluster, node pool id) of the node pool to set
management properties. Specified in the format
`projects/*/locations/*/clusters/*/nodePools/*`.
Generated from protobuf field <code>string name = 7;</code>
@param string $var
@return $this | setName | php | googleapis/google-cloud-php | Container/src/V1/SetNodePoolManagementRequest.php | https://github.com/googleapis/google-cloud-php/blob/master/Container/src/V1/SetNodePoolManagementRequest.php | Apache-2.0 |
public function getTrustAnchors()
{
return $this->trust_anchors;
} | List of Trust Anchors to be used while performing validation
against a given TrustStore.
Generated from protobuf field <code>repeated .google.cloud.certificatemanager.v1.TrustConfig.TrustAnchor trust_anchors = 1;</code>
@return \Google\Protobuf\Internal\RepeatedField | getTrustAnchors | php | googleapis/google-cloud-php | CertificateManager/src/V1/TrustConfig/TrustStore.php | https://github.com/googleapis/google-cloud-php/blob/master/CertificateManager/src/V1/TrustConfig/TrustStore.php | Apache-2.0 |
public function setTrustAnchors($var)
{
$arr = GPBUtil::checkRepeatedField($var, \Google\Protobuf\Internal\GPBType::MESSAGE, \Google\Cloud\CertificateManager\V1\TrustConfig\TrustAnchor::class);
$this->trust_anchors = $arr;
return $this;
} | List of Trust Anchors to be used while performing validation
against a given TrustStore.
Generated from protobuf field <code>repeated .google.cloud.certificatemanager.v1.TrustConfig.TrustAnchor trust_anchors = 1;</code>
@param array<\Google\Cloud\CertificateManager\V1\TrustConfig\TrustAnchor>|\Google\Protobuf\Internal\RepeatedField $var
@return $this | setTrustAnchors | php | googleapis/google-cloud-php | CertificateManager/src/V1/TrustConfig/TrustStore.php | https://github.com/googleapis/google-cloud-php/blob/master/CertificateManager/src/V1/TrustConfig/TrustStore.php | Apache-2.0 |
public function getIntermediateCas()
{
return $this->intermediate_cas;
} | Set of intermediate CA certificates used for the path building
phase of chain validation.
The field is currently not supported if TrustConfig is used for the
workload certificate feature.
Generated from protobuf field <code>repeated .google.cloud.certificatemanager.v1.TrustConfig.IntermediateCA intermediate_cas = 2;</code>
@return \Google\Protobuf\Internal\RepeatedField | getIntermediateCas | php | googleapis/google-cloud-php | CertificateManager/src/V1/TrustConfig/TrustStore.php | https://github.com/googleapis/google-cloud-php/blob/master/CertificateManager/src/V1/TrustConfig/TrustStore.php | Apache-2.0 |
public function setIntermediateCas($var)
{
$arr = GPBUtil::checkRepeatedField($var, \Google\Protobuf\Internal\GPBType::MESSAGE, \Google\Cloud\CertificateManager\V1\TrustConfig\IntermediateCA::class);
$this->intermediate_cas = $arr;
return $this;
} | Set of intermediate CA certificates used for the path building
phase of chain validation.
The field is currently not supported if TrustConfig is used for the
workload certificate feature.
Generated from protobuf field <code>repeated .google.cloud.certificatemanager.v1.TrustConfig.IntermediateCA intermediate_cas = 2;</code>
@param array<\Google\Cloud\CertificateManager\V1\TrustConfig\IntermediateCA>|\Google\Protobuf\Internal\RepeatedField $var
@return $this | setIntermediateCas | php | googleapis/google-cloud-php | CertificateManager/src/V1/TrustConfig/TrustStore.php | https://github.com/googleapis/google-cloud-php/blob/master/CertificateManager/src/V1/TrustConfig/TrustStore.php | Apache-2.0 |
public function __destruct()
{
$this->stream_close();
} | Ensure we close the stream when this StreamWrapper is destroyed. | __destruct | php | googleapis/google-cloud-php | Storage/src/StreamWrapper.php | https://github.com/googleapis/google-cloud-php/blob/master/Storage/src/StreamWrapper.php | Apache-2.0 |
public function stream_set_option()
{
return false;
} | This is called when include/require is used on a stream. | stream_set_option | php | googleapis/google-cloud-php | Storage/src/StreamWrapper.php | https://github.com/googleapis/google-cloud-php/blob/master/Storage/src/StreamWrapper.php | Apache-2.0 |
public function stream_metadata($path, $option, $value)
{
if ($option == STREAM_META_TOUCH) {
$this->openPath($path);
return $this->touch();
}
return false;
} | This is called when touch is used on a stream. See:
https://www.php.net/manual/en/streamwrapper.stream-metadata.php | stream_metadata | php | googleapis/google-cloud-php | Storage/src/StreamWrapper.php | https://github.com/googleapis/google-cloud-php/blob/master/Storage/src/StreamWrapper.php | Apache-2.0 |
private function touch()
{
$object = $this->bucket->object($this->file);
try {
if (!$object->exists()) {
$this->bucket->upload('', [
'name' => $this->file
]);
}
return true;
} catch (NotFoundException $e) {
}
return false;
} | Creates an empty file if it does not exist.
@return bool Returns true if file exists or has been created, false otherwise. | touch | php | googleapis/google-cloud-php | Storage/src/StreamWrapper.php | https://github.com/googleapis/google-cloud-php/blob/master/Storage/src/StreamWrapper.php | Apache-2.0 |
public static function register(StorageClient $client, $protocol = null)
{
$protocol = $protocol ?: self::DEFAULT_PROTOCOL;
if (!in_array($protocol, stream_get_wrappers())) {
if (!stream_wrapper_register($protocol, StreamWrapper::class, STREAM_IS_URL)) {
throw new \RuntimeException("Failed to register '$protocol://' protocol");
}
self::$clients[$protocol] = $client;
return true;
}
return false;
} | Register a StreamWrapper for reading and writing to Google Storage
@param StorageClient $client The StorageClient configuration to use.
@param string $protocol The name of the protocol to use. **Defaults to**
`gs`.
@throws \RuntimeException | register | php | googleapis/google-cloud-php | Storage/src/StreamWrapper.php | https://github.com/googleapis/google-cloud-php/blob/master/Storage/src/StreamWrapper.php | Apache-2.0 |
public static function unregister($protocol = null)
{
$protocol = $protocol ?: self::DEFAULT_PROTOCOL;
stream_wrapper_unregister($protocol);
unset(self::$clients[$protocol]);
} | Unregisters the SteamWrapper
@param string $protocol The name of the protocol to unregister. **Defaults
to** `gs`. | unregister | php | googleapis/google-cloud-php | Storage/src/StreamWrapper.php | https://github.com/googleapis/google-cloud-php/blob/master/Storage/src/StreamWrapper.php | Apache-2.0 |
public static function getClient($protocol = null)
{
$protocol = $protocol ?: self::DEFAULT_PROTOCOL;
return self::$clients[$protocol];
} | Get the default client to use for streams.
@param string $protocol The name of the protocol to get the client for.
**Defaults to** `gs`.
@return StorageClient | getClient | php | googleapis/google-cloud-php | Storage/src/StreamWrapper.php | https://github.com/googleapis/google-cloud-php/blob/master/Storage/src/StreamWrapper.php | Apache-2.0 |
public function stream_read($count)
{
return $this->stream->read($count);
} | Callback handler for when we try to read a certain number of bytes.
@param int $count The number of bytes to read.
@return string | stream_read | php | googleapis/google-cloud-php | Storage/src/StreamWrapper.php | https://github.com/googleapis/google-cloud-php/blob/master/Storage/src/StreamWrapper.php | Apache-2.0 |
public function stream_write($data)
{
$result = $this->stream->write($data);
$this->dirty = $this->dirty || (bool) $result;
return $result;
} | Callback handler for when we try to write data to the stream.
@param string $data The data to write
@return int The number of bytes written. | stream_write | php | googleapis/google-cloud-php | Storage/src/StreamWrapper.php | https://github.com/googleapis/google-cloud-php/blob/master/Storage/src/StreamWrapper.php | Apache-2.0 |
public function stream_stat()
{
$mode = $this->stream->isWritable()
? self::FILE_WRITABLE_MODE
: self::FILE_READABLE_MODE;
return $this->makeStatArray([
'mode' => $mode,
'size' => $this->stream->getSize()
]);
} | Callback handler for getting data about the stream.
@return array | stream_stat | php | googleapis/google-cloud-php | Storage/src/StreamWrapper.php | https://github.com/googleapis/google-cloud-php/blob/master/Storage/src/StreamWrapper.php | Apache-2.0 |
public function stream_eof()
{
return $this->stream->eof();
} | Callback handler for checking to see if the stream is at the end of file.
@return bool | stream_eof | php | googleapis/google-cloud-php | Storage/src/StreamWrapper.php | https://github.com/googleapis/google-cloud-php/blob/master/Storage/src/StreamWrapper.php | Apache-2.0 |
public function stream_close()
{
if (isset($this->stream)) {
$this->stream->close();
}
if ($this->composing) {
if ($this->dirty) {
$this->compose();
$this->dirty = false;
}
try {
$this->bucket->object($this->file . self::TAIL_NAME_SUFFIX)->delete();
} catch (NotFoundException $e) {
}
$this->composing = false;
}
} | Callback handler for trying to close the stream. | stream_close | php | googleapis/google-cloud-php | Storage/src/StreamWrapper.php | https://github.com/googleapis/google-cloud-php/blob/master/Storage/src/StreamWrapper.php | Apache-2.0 |
public function stream_seek($offset, $whence = SEEK_SET)
{
if ($this->stream->isSeekable()) {
$this->stream->seek($offset, $whence);
return true;
}
return false;
} | Callback handler for trying to seek to a certain location in the stream.
@param int $offset The stream offset to seek to
@param int $whence Flag for what the offset is relative to. See:
http://php.net/manual/en/streamwrapper.stream-seek.php
@return bool | stream_seek | php | googleapis/google-cloud-php | Storage/src/StreamWrapper.php | https://github.com/googleapis/google-cloud-php/blob/master/Storage/src/StreamWrapper.php | Apache-2.0 |
public function stream_tell()
{
return $this->stream->tell();
} | Callhack handler for inspecting our current position in the stream
@return int | stream_tell | php | googleapis/google-cloud-php | Storage/src/StreamWrapper.php | https://github.com/googleapis/google-cloud-php/blob/master/Storage/src/StreamWrapper.php | Apache-2.0 |
public function dir_closedir()
{
return false;
} | Callback handler for trying to close an opened directory.
@return bool | dir_closedir | php | googleapis/google-cloud-php | Storage/src/StreamWrapper.php | https://github.com/googleapis/google-cloud-php/blob/master/Storage/src/StreamWrapper.php | Apache-2.0 |
public function dir_opendir($path, $options)
{
$this->openPath($path);
return $this->dir_rewinddir();
} | Callback handler for trying to open a directory.
@param string $path The url directory to open
@param int $options Whether or not to enforce safe_mode
@return bool | dir_opendir | php | googleapis/google-cloud-php | Storage/src/StreamWrapper.php | https://github.com/googleapis/google-cloud-php/blob/master/Storage/src/StreamWrapper.php | Apache-2.0 |
public function dir_readdir()
{
$name = $this->directoryIterator->current();
if ($name) {
$this->directoryIterator->next();
return $name;
}
return false;
} | Callback handler for reading an entry from a directory handle.
@return string|bool | dir_readdir | php | googleapis/google-cloud-php | Storage/src/StreamWrapper.php | https://github.com/googleapis/google-cloud-php/blob/master/Storage/src/StreamWrapper.php | Apache-2.0 |
public function mkdir($path, $mode, $options)
{
$path = $this->makeDirectory($path);
$client = $this->openPath($path);
$predefinedAcl = $this->determineAclFromMode($mode);
try {
if ($options & STREAM_MKDIR_RECURSIVE || $this->file == '') {
if (!$this->bucket->exists()) {
$client->createBucket($this->bucket->name(), [
'predefinedAcl' => $predefinedAcl,
'predefinedDefaultObjectAcl' => $predefinedAcl
]);
}
}
// If the file name is empty, we were trying to create a bucket. In this case,
// don't create the placeholder file.
if ($this->file != '') {
$bucketInfo = $this->bucket->info();
$ublEnabled = isset($bucketInfo['iamConfiguration']['uniformBucketLevelAccess']) &&
$bucketInfo['iamConfiguration']['uniformBucketLevelAccess']['enabled'] === true;
// if bucket has uniform bucket level access enabled, don't set ACLs.
$acl = [];
if (!$ublEnabled) {
$acl = [
'predefinedAcl' => $predefinedAcl
];
}
// Fake a directory by creating an empty placeholder file whose name ends in '/'
$this->bucket->upload('', [
'name' => $this->file,
] + $acl);
}
} catch (ServiceException $e) {
return false;
}
return true;
} | Callback handler for trying to create a directory. If no file path is specified,
or STREAM_MKDIR_RECURSIVE option is set, then create the bucket if it does not exist.
@param string $path The url directory to create
@param int $mode The permissions on the directory
@param int $options Bitwise mask of options. STREAM_MKDIR_RECURSIVE
@return bool | mkdir | php | googleapis/google-cloud-php | Storage/src/StreamWrapper.php | https://github.com/googleapis/google-cloud-php/blob/master/Storage/src/StreamWrapper.php | Apache-2.0 |
public function rmdir($path, $options)
{
$path = $this->makeDirectory($path);
$this->openPath($path);
try {
if ($this->file == '') {
$this->bucket->delete();
return true;
} else {
return $this->unlink($path);
}
} catch (ServiceException $e) {
return false;
}
} | Callback handler for trying to remove a directory or a bucket. If the path is empty
or '/', the bucket will be deleted.
Note that the STREAM_MKDIR_RECURSIVE flag is ignored because the option cannot
be set via the `rmdir()` function.
@param string $path The URL directory to remove. If the path is empty or is '/',
This will attempt to destroy the bucket.
@param int $options Bitwise mask of options.
@return bool | rmdir | php | googleapis/google-cloud-php | Storage/src/StreamWrapper.php | https://github.com/googleapis/google-cloud-php/blob/master/Storage/src/StreamWrapper.php | Apache-2.0 |
public function stream_cast($castAs)
{
return false;
} | Callback handler for retrieving the underlaying resource
@param int $castAs STREAM_CAST_FOR_SELECT|STREAM_CAST_AS_STREAM
@return resource|bool | stream_cast | php | googleapis/google-cloud-php | Storage/src/StreamWrapper.php | https://github.com/googleapis/google-cloud-php/blob/master/Storage/src/StreamWrapper.php | Apache-2.0 |
public function unlink($path)
{
$client = $this->openPath($path);
$object = $this->bucket->object($this->file);
try {
$object->delete();
return true;
} catch (ServiceException $e) {
return false;
}
} | Callback handler for deleting a file
@param string $path The URL of the file to delete
@return bool | unlink | php | googleapis/google-cloud-php | Storage/src/StreamWrapper.php | https://github.com/googleapis/google-cloud-php/blob/master/Storage/src/StreamWrapper.php | Apache-2.0 |
public function url_stat($path, $flags)
{
$client = $this->openPath($path);
// if directory
$dir = $this->getDirectoryInfo($this->file);
if ($dir) {
return $this->urlStatDirectory($dir);
}
return $this->urlStatFile();
} | Callback handler for retrieving information about a file
@param string $path The URI to the file
@param int $flags Bitwise mask of options
@return array|bool | url_stat | php | googleapis/google-cloud-php | Storage/src/StreamWrapper.php | https://github.com/googleapis/google-cloud-php/blob/master/Storage/src/StreamWrapper.php | Apache-2.0 |
public function stream_flush()
{
if (!$this->flushing) {
return false;
}
if (!$this->dirty) {
return true;
}
if (isset($this->stream)) {
$this->stream->close();
}
if ($this->composing) {
$this->compose();
}
$options = $this->options;
$this->stream = new WriteStream(null, $options);
$this->stream->setUploader(
$this->bucket->getStreamableUploader(
$this->stream,
$options + ['name' => $this->file . self::TAIL_NAME_SUFFIX]
)
);
$this->composing = true;
$this->dirty = false;
return true;
} | Callback handler for fflush() function.
@return bool | stream_flush | php | googleapis/google-cloud-php | Storage/src/StreamWrapper.php | https://github.com/googleapis/google-cloud-php/blob/master/Storage/src/StreamWrapper.php | Apache-2.0 |
private function openPath($path)
{
$url = (array) parse_url($path) + [
'scheme' => '',
'path' => '',
'host' => ''
];
$this->protocol = $url['scheme'];
$this->file = ltrim($url['path'], '/');
$client = self::getClient($this->protocol);
$this->bucket = $client->bucket($url['host']);
return $client;
} | Parse the URL and set protocol, filename and bucket.
@param string $path URL to open
@return StorageClient | openPath | php | googleapis/google-cloud-php | Storage/src/StreamWrapper.php | https://github.com/googleapis/google-cloud-php/blob/master/Storage/src/StreamWrapper.php | Apache-2.0 |
private function makeDirectory($path)
{
if ($path == '' or $path == '/') {
return '';
}
if (substr($path, -1) == '/') {
return $path;
}
return $path . '/';
} | Given a path, ensure that we return a path that looks like a directory
@param string $path
@return string | makeDirectory | php | googleapis/google-cloud-php | Storage/src/StreamWrapper.php | https://github.com/googleapis/google-cloud-php/blob/master/Storage/src/StreamWrapper.php | Apache-2.0 |
private function urlStatDirectory(StorageObject $object)
{
$stats = [];
$info = $object->info();
// equivalent to 40777 and 40444 in octal
$stats['mode'] = $this->bucket->isWritable()
? self::DIRECTORY_WRITABLE_MODE
: self::DIRECTORY_READABLE_MODE;
$this->statsFromFileInfo($info, $stats);
return $this->makeStatArray($stats);
} | Calculate the `url_stat` response for a directory
@return array|bool | urlStatDirectory | php | googleapis/google-cloud-php | Storage/src/StreamWrapper.php | https://github.com/googleapis/google-cloud-php/blob/master/Storage/src/StreamWrapper.php | Apache-2.0 |
private function urlStatFile()
{
try {
$this->object = $this->bucket->object($this->file);
$info = $this->object->info();
} catch (ServiceException $e) {
// couldn't stat file
return false;
}
// equivalent to 100666 and 100444 in octal
$stats = [
'mode' => $this->bucket->isWritable()
? self::FILE_WRITABLE_MODE
: self::FILE_READABLE_MODE
];
$this->statsFromFileInfo($info, $stats);
return $this->makeStatArray($stats);
} | Calculate the `url_stat` response for a file
@return array|bool | urlStatFile | php | googleapis/google-cloud-php | Storage/src/StreamWrapper.php | https://github.com/googleapis/google-cloud-php/blob/master/Storage/src/StreamWrapper.php | Apache-2.0 |
private function statsFromFileInfo(array &$info, array &$stats)
{
$stats['size'] = (isset($info['size']))
? (int) $info['size']
: null;
$stats['mtime'] = (isset($info['updated']))
? strtotime($info['updated'])
: null;
$stats['ctime'] = (isset($info['timeCreated']))
? strtotime($info['timeCreated'])
: null;
} | Given a `StorageObject` info array, extract the available fields into the
provided `$stats` array.
@param array $info Array provided from a `StorageObject`.
@param array $stats Array to put the calculated stats into. | statsFromFileInfo | php | googleapis/google-cloud-php | Storage/src/StreamWrapper.php | https://github.com/googleapis/google-cloud-php/blob/master/Storage/src/StreamWrapper.php | Apache-2.0 |
private function getDirectoryInfo($path)
{
$scan = $this->bucket->objects([
'prefix' => $this->makeDirectory($path),
'resultLimit' => 1,
'fields' => 'items/name,items/size,items/updated,items/timeCreated,nextPageToken'
]);
return $scan->current();
} | Get the given path as a directory.
In list objects calls, directories are returned with a trailing slash. By
providing the given path with a trailing slash as a list prefix, we can
check whether the given path exists as a directory.
If the path does not exist or is not a directory, return null.
@param string $path
@return StorageObject|null | getDirectoryInfo | php | googleapis/google-cloud-php | Storage/src/StreamWrapper.php | https://github.com/googleapis/google-cloud-php/blob/master/Storage/src/StreamWrapper.php | Apache-2.0 |
private function makeStatArray($stats)
{
return array_merge(
array_fill_keys([
'dev',
'ino',
'mode',
'nlink',
'uid',
'gid',
'rdev',
'size',
'atime',
'mtime',
'ctime',
'blksize',
'blocks'
], 0),
$stats
);
} | Returns the associative array that a `stat()` response expects using the
provided stats. Defaults the remaining fields to 0.
@param array $stats Sparse stats entries to set.
@return array | makeStatArray | php | googleapis/google-cloud-php | Storage/src/StreamWrapper.php | https://github.com/googleapis/google-cloud-php/blob/master/Storage/src/StreamWrapper.php | Apache-2.0 |
private function returnError($message, $flags)
{
if ($flags & STREAM_REPORT_ERRORS) {
trigger_error($message, E_USER_WARNING);
}
return false;
} | Helper for whether or not to trigger an error or just return false on an error.
@param string $message The PHP error message to emit.
@param int $flags Bitwise mask of options (STREAM_REPORT_ERRORS)
@return bool Returns false | returnError | php | googleapis/google-cloud-php | Storage/src/StreamWrapper.php | https://github.com/googleapis/google-cloud-php/blob/master/Storage/src/StreamWrapper.php | Apache-2.0 |
private function determineAclFromMode($mode)
{
if ($mode & 0004) {
// If any user can read, assume it should be publicRead.
return 'publicRead';
} elseif ($mode & 0040) {
// If any group user can read, assume it should be projectPrivate.
return 'projectPrivate';
}
// Otherwise, assume only the project/bucket owner can use the bucket.
return 'private';
} | Helper for determining which predefinedAcl to use given a mode.
@param int $mode Decimal representation of the file system permissions
@return string | determineAclFromMode | php | googleapis/google-cloud-php | Storage/src/StreamWrapper.php | https://github.com/googleapis/google-cloud-php/blob/master/Storage/src/StreamWrapper.php | Apache-2.0 |
public function getGcsOutputBucket()
{
return $this->readOneof(1);
} | Optional. The Google Cloud Storage location to upload the result to.
Format: `gs://bucket-name`.
Generated from protobuf field <code>string gcs_output_bucket = 1 [(.google.api.field_behavior) = OPTIONAL];</code>
@return string | getGcsOutputBucket | php | googleapis/google-cloud-php | Dataform/src/V1beta1/NotebookRuntimeOptions.php | https://github.com/googleapis/google-cloud-php/blob/master/Dataform/src/V1beta1/NotebookRuntimeOptions.php | Apache-2.0 |
public function setGcsOutputBucket($var)
{
GPBUtil::checkString($var, True);
$this->writeOneof(1, $var);
return $this;
} | Optional. The Google Cloud Storage location to upload the result to.
Format: `gs://bucket-name`.
Generated from protobuf field <code>string gcs_output_bucket = 1 [(.google.api.field_behavior) = OPTIONAL];</code>
@param string $var
@return $this | setGcsOutputBucket | php | googleapis/google-cloud-php | Dataform/src/V1beta1/NotebookRuntimeOptions.php | https://github.com/googleapis/google-cloud-php/blob/master/Dataform/src/V1beta1/NotebookRuntimeOptions.php | Apache-2.0 |
public function getSetCell()
{
return $this->readOneof(1);
} | Set a cell's value.
Generated from protobuf field <code>.google.bigtable.v2.Mutation.SetCell set_cell = 1;</code>
@return \Google\Cloud\Bigtable\V2\Mutation\SetCell|null | getSetCell | php | googleapis/google-cloud-php | Bigtable/src/V2/Mutation.php | https://github.com/googleapis/google-cloud-php/blob/master/Bigtable/src/V2/Mutation.php | Apache-2.0 |
public function setSetCell($var)
{
GPBUtil::checkMessage($var, \Google\Cloud\Bigtable\V2\Mutation\SetCell::class);
$this->writeOneof(1, $var);
return $this;
} | Set a cell's value.
Generated from protobuf field <code>.google.bigtable.v2.Mutation.SetCell set_cell = 1;</code>
@param \Google\Cloud\Bigtable\V2\Mutation\SetCell $var
@return $this | setSetCell | php | googleapis/google-cloud-php | Bigtable/src/V2/Mutation.php | https://github.com/googleapis/google-cloud-php/blob/master/Bigtable/src/V2/Mutation.php | Apache-2.0 |
public function getAddToCell()
{
return $this->readOneof(5);
} | Incrementally updates an `Aggregate` cell.
Generated from protobuf field <code>.google.bigtable.v2.Mutation.AddToCell add_to_cell = 5;</code>
@return \Google\Cloud\Bigtable\V2\Mutation\AddToCell|null | getAddToCell | php | googleapis/google-cloud-php | Bigtable/src/V2/Mutation.php | https://github.com/googleapis/google-cloud-php/blob/master/Bigtable/src/V2/Mutation.php | Apache-2.0 |
public function setAddToCell($var)
{
GPBUtil::checkMessage($var, \Google\Cloud\Bigtable\V2\Mutation\AddToCell::class);
$this->writeOneof(5, $var);
return $this;
} | Incrementally updates an `Aggregate` cell.
Generated from protobuf field <code>.google.bigtable.v2.Mutation.AddToCell add_to_cell = 5;</code>
@param \Google\Cloud\Bigtable\V2\Mutation\AddToCell $var
@return $this | setAddToCell | php | googleapis/google-cloud-php | Bigtable/src/V2/Mutation.php | https://github.com/googleapis/google-cloud-php/blob/master/Bigtable/src/V2/Mutation.php | Apache-2.0 |
public function getMergeToCell()
{
return $this->readOneof(6);
} | Merges accumulated state to an `Aggregate` cell.
Generated from protobuf field <code>.google.bigtable.v2.Mutation.MergeToCell merge_to_cell = 6;</code>
@return \Google\Cloud\Bigtable\V2\Mutation\MergeToCell|null | getMergeToCell | php | googleapis/google-cloud-php | Bigtable/src/V2/Mutation.php | https://github.com/googleapis/google-cloud-php/blob/master/Bigtable/src/V2/Mutation.php | Apache-2.0 |
public function setMergeToCell($var)
{
GPBUtil::checkMessage($var, \Google\Cloud\Bigtable\V2\Mutation\MergeToCell::class);
$this->writeOneof(6, $var);
return $this;
} | Merges accumulated state to an `Aggregate` cell.
Generated from protobuf field <code>.google.bigtable.v2.Mutation.MergeToCell merge_to_cell = 6;</code>
@param \Google\Cloud\Bigtable\V2\Mutation\MergeToCell $var
@return $this | setMergeToCell | php | googleapis/google-cloud-php | Bigtable/src/V2/Mutation.php | https://github.com/googleapis/google-cloud-php/blob/master/Bigtable/src/V2/Mutation.php | Apache-2.0 |
public function getDeleteFromColumn()
{
return $this->readOneof(2);
} | Deletes cells from a column.
Generated from protobuf field <code>.google.bigtable.v2.Mutation.DeleteFromColumn delete_from_column = 2;</code>
@return \Google\Cloud\Bigtable\V2\Mutation\DeleteFromColumn|null | getDeleteFromColumn | php | googleapis/google-cloud-php | Bigtable/src/V2/Mutation.php | https://github.com/googleapis/google-cloud-php/blob/master/Bigtable/src/V2/Mutation.php | Apache-2.0 |
public function setDeleteFromColumn($var)
{
GPBUtil::checkMessage($var, \Google\Cloud\Bigtable\V2\Mutation\DeleteFromColumn::class);
$this->writeOneof(2, $var);
return $this;
} | Deletes cells from a column.
Generated from protobuf field <code>.google.bigtable.v2.Mutation.DeleteFromColumn delete_from_column = 2;</code>
@param \Google\Cloud\Bigtable\V2\Mutation\DeleteFromColumn $var
@return $this | setDeleteFromColumn | php | googleapis/google-cloud-php | Bigtable/src/V2/Mutation.php | https://github.com/googleapis/google-cloud-php/blob/master/Bigtable/src/V2/Mutation.php | Apache-2.0 |
public function getDeleteFromFamily()
{
return $this->readOneof(3);
} | Deletes cells from a column family.
Generated from protobuf field <code>.google.bigtable.v2.Mutation.DeleteFromFamily delete_from_family = 3;</code>
@return \Google\Cloud\Bigtable\V2\Mutation\DeleteFromFamily|null | getDeleteFromFamily | php | googleapis/google-cloud-php | Bigtable/src/V2/Mutation.php | https://github.com/googleapis/google-cloud-php/blob/master/Bigtable/src/V2/Mutation.php | Apache-2.0 |
public function setDeleteFromFamily($var)
{
GPBUtil::checkMessage($var, \Google\Cloud\Bigtable\V2\Mutation\DeleteFromFamily::class);
$this->writeOneof(3, $var);
return $this;
} | Deletes cells from a column family.
Generated from protobuf field <code>.google.bigtable.v2.Mutation.DeleteFromFamily delete_from_family = 3;</code>
@param \Google\Cloud\Bigtable\V2\Mutation\DeleteFromFamily $var
@return $this | setDeleteFromFamily | php | googleapis/google-cloud-php | Bigtable/src/V2/Mutation.php | https://github.com/googleapis/google-cloud-php/blob/master/Bigtable/src/V2/Mutation.php | Apache-2.0 |
public function getDeleteFromRow()
{
return $this->readOneof(4);
} | Deletes cells from the entire row.
Generated from protobuf field <code>.google.bigtable.v2.Mutation.DeleteFromRow delete_from_row = 4;</code>
@return \Google\Cloud\Bigtable\V2\Mutation\DeleteFromRow|null | getDeleteFromRow | php | googleapis/google-cloud-php | Bigtable/src/V2/Mutation.php | https://github.com/googleapis/google-cloud-php/blob/master/Bigtable/src/V2/Mutation.php | Apache-2.0 |
public function setDeleteFromRow($var)
{
GPBUtil::checkMessage($var, \Google\Cloud\Bigtable\V2\Mutation\DeleteFromRow::class);
$this->writeOneof(4, $var);
return $this;
} | Deletes cells from the entire row.
Generated from protobuf field <code>.google.bigtable.v2.Mutation.DeleteFromRow delete_from_row = 4;</code>
@param \Google\Cloud\Bigtable\V2\Mutation\DeleteFromRow $var
@return $this | setDeleteFromRow | php | googleapis/google-cloud-php | Bigtable/src/V2/Mutation.php | https://github.com/googleapis/google-cloud-php/blob/master/Bigtable/src/V2/Mutation.php | Apache-2.0 |
public function getMissingPermissions()
{
return $this->missing_permissions;
} | List of permissions that are being denied.
Generated from protobuf field <code>repeated string missing_permissions = 1;</code>
@return \Google\Protobuf\Internal\RepeatedField | getMissingPermissions | php | googleapis/google-cloud-php | PrivilegedAccessManager/src/V1/CheckOnboardingStatusResponse/Finding/IAMAccessDenied.php | https://github.com/googleapis/google-cloud-php/blob/master/PrivilegedAccessManager/src/V1/CheckOnboardingStatusResponse/Finding/IAMAccessDenied.php | Apache-2.0 |
public function setMissingPermissions($var)
{
$arr = GPBUtil::checkRepeatedField($var, \Google\Protobuf\Internal\GPBType::STRING);
$this->missing_permissions = $arr;
return $this;
} | List of permissions that are being denied.
Generated from protobuf field <code>repeated string missing_permissions = 1;</code>
@param array<string>|\Google\Protobuf\Internal\RepeatedField $var
@return $this | setMissingPermissions | php | googleapis/google-cloud-php | PrivilegedAccessManager/src/V1/CheckOnboardingStatusResponse/Finding/IAMAccessDenied.php | https://github.com/googleapis/google-cloud-php/blob/master/PrivilegedAccessManager/src/V1/CheckOnboardingStatusResponse/Finding/IAMAccessDenied.php | Apache-2.0 |
public function getParent()
{
return $this->parent;
} | Required. The parent resource's name.
Generated from protobuf field <code>string parent = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = {</code>
@return string | getParent | php | googleapis/google-cloud-php | NetworkConnectivity/src/V1/ListRoutesRequest.php | https://github.com/googleapis/google-cloud-php/blob/master/NetworkConnectivity/src/V1/ListRoutesRequest.php | Apache-2.0 |
public function setParent($var)
{
GPBUtil::checkString($var, True);
$this->parent = $var;
return $this;
} | Required. The parent resource's name.
Generated from protobuf field <code>string parent = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = {</code>
@param string $var
@return $this | setParent | php | googleapis/google-cloud-php | NetworkConnectivity/src/V1/ListRoutesRequest.php | https://github.com/googleapis/google-cloud-php/blob/master/NetworkConnectivity/src/V1/ListRoutesRequest.php | Apache-2.0 |
public function getPageSize()
{
return $this->page_size;
} | The maximum number of results to return per page.
Generated from protobuf field <code>int32 page_size = 2;</code>
@return int | getPageSize | php | googleapis/google-cloud-php | NetworkConnectivity/src/V1/ListRoutesRequest.php | https://github.com/googleapis/google-cloud-php/blob/master/NetworkConnectivity/src/V1/ListRoutesRequest.php | Apache-2.0 |
public function setPageSize($var)
{
GPBUtil::checkInt32($var);
$this->page_size = $var;
return $this;
} | The maximum number of results to return per page.
Generated from protobuf field <code>int32 page_size = 2;</code>
@param int $var
@return $this | setPageSize | php | googleapis/google-cloud-php | NetworkConnectivity/src/V1/ListRoutesRequest.php | https://github.com/googleapis/google-cloud-php/blob/master/NetworkConnectivity/src/V1/ListRoutesRequest.php | Apache-2.0 |
public function getPageToken()
{
return $this->page_token;
} | The page token.
Generated from protobuf field <code>string page_token = 3;</code>
@return string | getPageToken | php | googleapis/google-cloud-php | NetworkConnectivity/src/V1/ListRoutesRequest.php | https://github.com/googleapis/google-cloud-php/blob/master/NetworkConnectivity/src/V1/ListRoutesRequest.php | Apache-2.0 |
public function setPageToken($var)
{
GPBUtil::checkString($var, True);
$this->page_token = $var;
return $this;
} | The page token.
Generated from protobuf field <code>string page_token = 3;</code>
@param string $var
@return $this | setPageToken | php | googleapis/google-cloud-php | NetworkConnectivity/src/V1/ListRoutesRequest.php | https://github.com/googleapis/google-cloud-php/blob/master/NetworkConnectivity/src/V1/ListRoutesRequest.php | Apache-2.0 |
public function getFilter()
{
return $this->filter;
} | An expression that filters the list of results.
Generated from protobuf field <code>string filter = 4;</code>
@return string | getFilter | php | googleapis/google-cloud-php | NetworkConnectivity/src/V1/ListRoutesRequest.php | https://github.com/googleapis/google-cloud-php/blob/master/NetworkConnectivity/src/V1/ListRoutesRequest.php | Apache-2.0 |
public function setFilter($var)
{
GPBUtil::checkString($var, True);
$this->filter = $var;
return $this;
} | An expression that filters the list of results.
Generated from protobuf field <code>string filter = 4;</code>
@param string $var
@return $this | setFilter | php | googleapis/google-cloud-php | NetworkConnectivity/src/V1/ListRoutesRequest.php | https://github.com/googleapis/google-cloud-php/blob/master/NetworkConnectivity/src/V1/ListRoutesRequest.php | Apache-2.0 |
public function getOrderBy()
{
return $this->order_by;
} | Sort the results by a certain order.
Generated from protobuf field <code>string order_by = 5;</code>
@return string | getOrderBy | php | googleapis/google-cloud-php | NetworkConnectivity/src/V1/ListRoutesRequest.php | https://github.com/googleapis/google-cloud-php/blob/master/NetworkConnectivity/src/V1/ListRoutesRequest.php | Apache-2.0 |
public function setOrderBy($var)
{
GPBUtil::checkString($var, True);
$this->order_by = $var;
return $this;
} | Sort the results by a certain order.
Generated from protobuf field <code>string order_by = 5;</code>
@param string $var
@return $this | setOrderBy | php | googleapis/google-cloud-php | NetworkConnectivity/src/V1/ListRoutesRequest.php | https://github.com/googleapis/google-cloud-php/blob/master/NetworkConnectivity/src/V1/ListRoutesRequest.php | Apache-2.0 |
public function getParent()
{
return $this->parent;
} | Required. The metadata store to purge Contexts from.
Format:
`projects/{project}/locations/{location}/metadataStores/{metadatastore}`
Generated from protobuf field <code>string parent = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = {</code>
@return string | getParent | php | googleapis/google-cloud-php | AiPlatform/src/V1/PurgeContextsRequest.php | https://github.com/googleapis/google-cloud-php/blob/master/AiPlatform/src/V1/PurgeContextsRequest.php | Apache-2.0 |
public function setParent($var)
{
GPBUtil::checkString($var, True);
$this->parent = $var;
return $this;
} | Required. The metadata store to purge Contexts from.
Format:
`projects/{project}/locations/{location}/metadataStores/{metadatastore}`
Generated from protobuf field <code>string parent = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = {</code>
@param string $var
@return $this | setParent | php | googleapis/google-cloud-php | AiPlatform/src/V1/PurgeContextsRequest.php | https://github.com/googleapis/google-cloud-php/blob/master/AiPlatform/src/V1/PurgeContextsRequest.php | Apache-2.0 |
public function getFilter()
{
return $this->filter;
} | Required. A required filter matching the Contexts to be purged.
E.g., `update_time <= 2020-11-19T11:30:00-04:00`.
Generated from protobuf field <code>string filter = 2 [(.google.api.field_behavior) = REQUIRED];</code>
@return string | getFilter | php | googleapis/google-cloud-php | AiPlatform/src/V1/PurgeContextsRequest.php | https://github.com/googleapis/google-cloud-php/blob/master/AiPlatform/src/V1/PurgeContextsRequest.php | Apache-2.0 |
public function setFilter($var)
{
GPBUtil::checkString($var, True);
$this->filter = $var;
return $this;
} | Required. A required filter matching the Contexts to be purged.
E.g., `update_time <= 2020-11-19T11:30:00-04:00`.
Generated from protobuf field <code>string filter = 2 [(.google.api.field_behavior) = REQUIRED];</code>
@param string $var
@return $this | setFilter | php | googleapis/google-cloud-php | AiPlatform/src/V1/PurgeContextsRequest.php | https://github.com/googleapis/google-cloud-php/blob/master/AiPlatform/src/V1/PurgeContextsRequest.php | Apache-2.0 |
public function getForce()
{
return $this->force;
} | Optional. Flag to indicate to actually perform the purge.
If `force` is set to false, the method will return a sample of
Context names that would be deleted.
Generated from protobuf field <code>bool force = 3 [(.google.api.field_behavior) = OPTIONAL];</code>
@return bool | getForce | php | googleapis/google-cloud-php | AiPlatform/src/V1/PurgeContextsRequest.php | https://github.com/googleapis/google-cloud-php/blob/master/AiPlatform/src/V1/PurgeContextsRequest.php | Apache-2.0 |
public function setForce($var)
{
GPBUtil::checkBool($var);
$this->force = $var;
return $this;
} | Optional. Flag to indicate to actually perform the purge.
If `force` is set to false, the method will return a sample of
Context names that would be deleted.
Generated from protobuf field <code>bool force = 3 [(.google.api.field_behavior) = OPTIONAL];</code>
@param bool $var
@return $this | setForce | php | googleapis/google-cloud-php | AiPlatform/src/V1/PurgeContextsRequest.php | https://github.com/googleapis/google-cloud-php/blob/master/AiPlatform/src/V1/PurgeContextsRequest.php | Apache-2.0 |
public function getVersion()
{
return $this->version;
} | Optional. Which version to use for evaluation.
Generated from protobuf field <code>int32 version = 1 [(.google.api.field_behavior) = OPTIONAL];</code>
@return int | getVersion | php | googleapis/google-cloud-php | AiPlatform/src/V1/CoherenceSpec.php | https://github.com/googleapis/google-cloud-php/blob/master/AiPlatform/src/V1/CoherenceSpec.php | Apache-2.0 |
public function setVersion($var)
{
GPBUtil::checkInt32($var);
$this->version = $var;
return $this;
} | Optional. Which version to use for evaluation.
Generated from protobuf field <code>int32 version = 1 [(.google.api.field_behavior) = OPTIONAL];</code>
@param int $var
@return $this | setVersion | php | googleapis/google-cloud-php | AiPlatform/src/V1/CoherenceSpec.php | https://github.com/googleapis/google-cloud-php/blob/master/AiPlatform/src/V1/CoherenceSpec.php | Apache-2.0 |
public function getParent()
{
return $this->parent;
} | Required. The parent eventStore resource name, such as
`projects/1234/locations/global/catalogs/default_catalog/eventStores/default_event_store`.
Generated from protobuf field <code>string parent = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = {</code>
@return string | getParent | php | googleapis/google-cloud-php | RecommendationEngine/src/V1beta1/WriteUserEventRequest.php | https://github.com/googleapis/google-cloud-php/blob/master/RecommendationEngine/src/V1beta1/WriteUserEventRequest.php | Apache-2.0 |
public function setParent($var)
{
GPBUtil::checkString($var, True);
$this->parent = $var;
return $this;
} | Required. The parent eventStore resource name, such as
`projects/1234/locations/global/catalogs/default_catalog/eventStores/default_event_store`.
Generated from protobuf field <code>string parent = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = {</code>
@param string $var
@return $this | setParent | php | googleapis/google-cloud-php | RecommendationEngine/src/V1beta1/WriteUserEventRequest.php | https://github.com/googleapis/google-cloud-php/blob/master/RecommendationEngine/src/V1beta1/WriteUserEventRequest.php | Apache-2.0 |
public function getUserEvent()
{
return $this->user_event;
} | Required. User event to write.
Generated from protobuf field <code>.google.cloud.recommendationengine.v1beta1.UserEvent user_event = 2 [(.google.api.field_behavior) = REQUIRED];</code>
@return \Google\Cloud\RecommendationEngine\V1beta1\UserEvent|null | getUserEvent | php | googleapis/google-cloud-php | RecommendationEngine/src/V1beta1/WriteUserEventRequest.php | https://github.com/googleapis/google-cloud-php/blob/master/RecommendationEngine/src/V1beta1/WriteUserEventRequest.php | Apache-2.0 |
public function setUserEvent($var)
{
GPBUtil::checkMessage($var, \Google\Cloud\RecommendationEngine\V1beta1\UserEvent::class);
$this->user_event = $var;
return $this;
} | Required. User event to write.
Generated from protobuf field <code>.google.cloud.recommendationengine.v1beta1.UserEvent user_event = 2 [(.google.api.field_behavior) = REQUIRED];</code>
@param \Google\Cloud\RecommendationEngine\V1beta1\UserEvent $var
@return $this | setUserEvent | php | googleapis/google-cloud-php | RecommendationEngine/src/V1beta1/WriteUserEventRequest.php | https://github.com/googleapis/google-cloud-php/blob/master/RecommendationEngine/src/V1beta1/WriteUserEventRequest.php | Apache-2.0 |
public function getAttributionLookbackWindowDays()
{
return $this->attribution_lookback_window_days;
} | Required. Lookback windows (in days) used for attribution in this source.
Supported values are 7, 30, 40.
Generated from protobuf field <code>int32 attribution_lookback_window_days = 1 [(.google.api.field_behavior) = REQUIRED];</code>
@return int | getAttributionLookbackWindowDays | php | googleapis/google-cloud-php | ShoppingMerchantConversions/src/V1beta/AttributionSettings.php | https://github.com/googleapis/google-cloud-php/blob/master/ShoppingMerchantConversions/src/V1beta/AttributionSettings.php | Apache-2.0 |
public function setAttributionLookbackWindowDays($var)
{
GPBUtil::checkInt32($var);
$this->attribution_lookback_window_days = $var;
return $this;
} | Required. Lookback windows (in days) used for attribution in this source.
Supported values are 7, 30, 40.
Generated from protobuf field <code>int32 attribution_lookback_window_days = 1 [(.google.api.field_behavior) = REQUIRED];</code>
@param int $var
@return $this | setAttributionLookbackWindowDays | php | googleapis/google-cloud-php | ShoppingMerchantConversions/src/V1beta/AttributionSettings.php | https://github.com/googleapis/google-cloud-php/blob/master/ShoppingMerchantConversions/src/V1beta/AttributionSettings.php | Apache-2.0 |
public function getAttributionModel()
{
return $this->attribution_model;
} | Required. Attribution model.
Generated from protobuf field <code>.google.shopping.merchant.conversions.v1beta.AttributionSettings.AttributionModel attribution_model = 2 [(.google.api.field_behavior) = REQUIRED];</code>
@return int | getAttributionModel | php | googleapis/google-cloud-php | ShoppingMerchantConversions/src/V1beta/AttributionSettings.php | https://github.com/googleapis/google-cloud-php/blob/master/ShoppingMerchantConversions/src/V1beta/AttributionSettings.php | Apache-2.0 |
public function setAttributionModel($var)
{
GPBUtil::checkEnum($var, \Google\Shopping\Merchant\Conversions\V1beta\AttributionSettings\AttributionModel::class);
$this->attribution_model = $var;
return $this;
} | Required. Attribution model.
Generated from protobuf field <code>.google.shopping.merchant.conversions.v1beta.AttributionSettings.AttributionModel attribution_model = 2 [(.google.api.field_behavior) = REQUIRED];</code>
@param int $var
@return $this | setAttributionModel | php | googleapis/google-cloud-php | ShoppingMerchantConversions/src/V1beta/AttributionSettings.php | https://github.com/googleapis/google-cloud-php/blob/master/ShoppingMerchantConversions/src/V1beta/AttributionSettings.php | Apache-2.0 |
public function getConversionType()
{
return $this->conversion_type;
} | Immutable. Unordered list. List of different conversion types a conversion
event can be classified as. A standard "purchase" type will be
automatically created if this list is empty at creation time.
Generated from protobuf field <code>repeated .google.shopping.merchant.conversions.v1beta.AttributionSettings.ConversionType conversion_type = 3 [(.google.api.field_behavior) = UNORDERED_LIST, (.google.api.field_behavior) = IMMUTABLE];</code>
@return \Google\Protobuf\Internal\RepeatedField | getConversionType | php | googleapis/google-cloud-php | ShoppingMerchantConversions/src/V1beta/AttributionSettings.php | https://github.com/googleapis/google-cloud-php/blob/master/ShoppingMerchantConversions/src/V1beta/AttributionSettings.php | Apache-2.0 |
public function setConversionType($var)
{
$arr = GPBUtil::checkRepeatedField($var, \Google\Protobuf\Internal\GPBType::MESSAGE, \Google\Shopping\Merchant\Conversions\V1beta\AttributionSettings\ConversionType::class);
$this->conversion_type = $arr;
return $this;
} | Immutable. Unordered list. List of different conversion types a conversion
event can be classified as. A standard "purchase" type will be
automatically created if this list is empty at creation time.
Generated from protobuf field <code>repeated .google.shopping.merchant.conversions.v1beta.AttributionSettings.ConversionType conversion_type = 3 [(.google.api.field_behavior) = UNORDERED_LIST, (.google.api.field_behavior) = IMMUTABLE];</code>
@param array<\Google\Shopping\Merchant\Conversions\V1beta\AttributionSettings\ConversionType>|\Google\Protobuf\Internal\RepeatedField $var
@return $this | setConversionType | php | googleapis/google-cloud-php | ShoppingMerchantConversions/src/V1beta/AttributionSettings.php | https://github.com/googleapis/google-cloud-php/blob/master/ShoppingMerchantConversions/src/V1beta/AttributionSettings.php | Apache-2.0 |
public function getDimensions()
{
return $this->dimensions;
} | Required. The list of dimensions to report on. If empty, the report will
have no dimensions, and any metrics will be totals.
Generated from protobuf field <code>repeated .google.ads.admanager.v1.Report.Dimension dimensions = 1 [(.google.api.field_behavior) = REQUIRED];</code>
@return \Google\Protobuf\Internal\RepeatedField | getDimensions | php | googleapis/google-cloud-php | AdsAdManager/src/V1/ReportDefinition.php | https://github.com/googleapis/google-cloud-php/blob/master/AdsAdManager/src/V1/ReportDefinition.php | Apache-2.0 |
public function setDimensions($var)
{
$arr = GPBUtil::checkRepeatedField($var, \Google\Protobuf\Internal\GPBType::ENUM, \Google\Ads\AdManager\V1\Report\Dimension::class);
$this->dimensions = $arr;
return $this;
} | Required. The list of dimensions to report on. If empty, the report will
have no dimensions, and any metrics will be totals.
Generated from protobuf field <code>repeated .google.ads.admanager.v1.Report.Dimension dimensions = 1 [(.google.api.field_behavior) = REQUIRED];</code>
@param array<int>|\Google\Protobuf\Internal\RepeatedField $var
@return $this | setDimensions | php | googleapis/google-cloud-php | AdsAdManager/src/V1/ReportDefinition.php | https://github.com/googleapis/google-cloud-php/blob/master/AdsAdManager/src/V1/ReportDefinition.php | Apache-2.0 |
public function getMetrics()
{
return $this->metrics;
} | Required. The list of metrics to report on. If empty, the report will have
no metrics.
Generated from protobuf field <code>repeated .google.ads.admanager.v1.Report.Metric metrics = 2 [(.google.api.field_behavior) = REQUIRED];</code>
@return \Google\Protobuf\Internal\RepeatedField | getMetrics | php | googleapis/google-cloud-php | AdsAdManager/src/V1/ReportDefinition.php | https://github.com/googleapis/google-cloud-php/blob/master/AdsAdManager/src/V1/ReportDefinition.php | Apache-2.0 |
public function setMetrics($var)
{
$arr = GPBUtil::checkRepeatedField($var, \Google\Protobuf\Internal\GPBType::ENUM, \Google\Ads\AdManager\V1\Report\Metric::class);
$this->metrics = $arr;
return $this;
} | Required. The list of metrics to report on. If empty, the report will have
no metrics.
Generated from protobuf field <code>repeated .google.ads.admanager.v1.Report.Metric metrics = 2 [(.google.api.field_behavior) = REQUIRED];</code>
@param array<int>|\Google\Protobuf\Internal\RepeatedField $var
@return $this | setMetrics | php | googleapis/google-cloud-php | AdsAdManager/src/V1/ReportDefinition.php | https://github.com/googleapis/google-cloud-php/blob/master/AdsAdManager/src/V1/ReportDefinition.php | Apache-2.0 |
public function getFilters()
{
return $this->filters;
} | Optional. The filters for this report.
Generated from protobuf field <code>repeated .google.ads.admanager.v1.Report.Filter filters = 3 [(.google.api.field_behavior) = OPTIONAL];</code>
@return \Google\Protobuf\Internal\RepeatedField | getFilters | php | googleapis/google-cloud-php | AdsAdManager/src/V1/ReportDefinition.php | https://github.com/googleapis/google-cloud-php/blob/master/AdsAdManager/src/V1/ReportDefinition.php | Apache-2.0 |
public function setFilters($var)
{
$arr = GPBUtil::checkRepeatedField($var, \Google\Protobuf\Internal\GPBType::MESSAGE, \Google\Ads\AdManager\V1\Report\Filter::class);
$this->filters = $arr;
return $this;
} | Optional. The filters for this report.
Generated from protobuf field <code>repeated .google.ads.admanager.v1.Report.Filter filters = 3 [(.google.api.field_behavior) = OPTIONAL];</code>
@param array<\Google\Ads\AdManager\V1\Report\Filter>|\Google\Protobuf\Internal\RepeatedField $var
@return $this | setFilters | php | googleapis/google-cloud-php | AdsAdManager/src/V1/ReportDefinition.php | https://github.com/googleapis/google-cloud-php/blob/master/AdsAdManager/src/V1/ReportDefinition.php | Apache-2.0 |
public function getTimeZone()
{
return $this->time_zone;
} | Optional. The time zone the date range is defined in for this report.
Defaults to publisher's time zone if not specified. Time zone in IANA
format. Acceptable values depend on the report type. Publisher time zone is
always accepted. Use "America/Los_Angeles" for pacific time, or "Etc/UTC"
for UTC.
Generated from protobuf field <code>string time_zone = 4 [(.google.api.field_behavior) = OPTIONAL];</code>
@return string | getTimeZone | php | googleapis/google-cloud-php | AdsAdManager/src/V1/ReportDefinition.php | https://github.com/googleapis/google-cloud-php/blob/master/AdsAdManager/src/V1/ReportDefinition.php | Apache-2.0 |
public function setTimeZone($var)
{
GPBUtil::checkString($var, True);
$this->time_zone = $var;
return $this;
} | Optional. The time zone the date range is defined in for this report.
Defaults to publisher's time zone if not specified. Time zone in IANA
format. Acceptable values depend on the report type. Publisher time zone is
always accepted. Use "America/Los_Angeles" for pacific time, or "Etc/UTC"
for UTC.
Generated from protobuf field <code>string time_zone = 4 [(.google.api.field_behavior) = OPTIONAL];</code>
@param string $var
@return $this | setTimeZone | php | googleapis/google-cloud-php | AdsAdManager/src/V1/ReportDefinition.php | https://github.com/googleapis/google-cloud-php/blob/master/AdsAdManager/src/V1/ReportDefinition.php | Apache-2.0 |
public function getCurrencyCode()
{
return $this->currency_code;
} | Optional. The ISO 4217 currency code for this report. Defaults to publisher
currency code if not specified.
Generated from protobuf field <code>string currency_code = 5 [(.google.api.field_behavior) = OPTIONAL];</code>
@return string | getCurrencyCode | php | googleapis/google-cloud-php | AdsAdManager/src/V1/ReportDefinition.php | https://github.com/googleapis/google-cloud-php/blob/master/AdsAdManager/src/V1/ReportDefinition.php | Apache-2.0 |
public function setCurrencyCode($var)
{
GPBUtil::checkString($var, True);
$this->currency_code = $var;
return $this;
} | Optional. The ISO 4217 currency code for this report. Defaults to publisher
currency code if not specified.
Generated from protobuf field <code>string currency_code = 5 [(.google.api.field_behavior) = OPTIONAL];</code>
@param string $var
@return $this | setCurrencyCode | php | googleapis/google-cloud-php | AdsAdManager/src/V1/ReportDefinition.php | https://github.com/googleapis/google-cloud-php/blob/master/AdsAdManager/src/V1/ReportDefinition.php | Apache-2.0 |
public function getDateRange()
{
return $this->date_range;
} | Required. The primary date range of this report.
Generated from protobuf field <code>.google.ads.admanager.v1.Report.DateRange date_range = 6 [(.google.api.field_behavior) = REQUIRED];</code>
@return \Google\Ads\AdManager\V1\Report\DateRange|null | getDateRange | php | googleapis/google-cloud-php | AdsAdManager/src/V1/ReportDefinition.php | https://github.com/googleapis/google-cloud-php/blob/master/AdsAdManager/src/V1/ReportDefinition.php | Apache-2.0 |
public function setDateRange($var)
{
GPBUtil::checkMessage($var, \Google\Ads\AdManager\V1\Report\DateRange::class);
$this->date_range = $var;
return $this;
} | Required. The primary date range of this report.
Generated from protobuf field <code>.google.ads.admanager.v1.Report.DateRange date_range = 6 [(.google.api.field_behavior) = REQUIRED];</code>
@param \Google\Ads\AdManager\V1\Report\DateRange $var
@return $this | setDateRange | php | googleapis/google-cloud-php | AdsAdManager/src/V1/ReportDefinition.php | https://github.com/googleapis/google-cloud-php/blob/master/AdsAdManager/src/V1/ReportDefinition.php | Apache-2.0 |
public function getComparisonDateRange()
{
return $this->comparison_date_range;
} | Optional. The comparison date range of this report. If unspecified, the
report will not have any comparison metrics.
Generated from protobuf field <code>optional .google.ads.admanager.v1.Report.DateRange comparison_date_range = 9 [(.google.api.field_behavior) = OPTIONAL];</code>
@return \Google\Ads\AdManager\V1\Report\DateRange|null | getComparisonDateRange | php | googleapis/google-cloud-php | AdsAdManager/src/V1/ReportDefinition.php | https://github.com/googleapis/google-cloud-php/blob/master/AdsAdManager/src/V1/ReportDefinition.php | Apache-2.0 |
public function setComparisonDateRange($var)
{
GPBUtil::checkMessage($var, \Google\Ads\AdManager\V1\Report\DateRange::class);
$this->comparison_date_range = $var;
return $this;
} | Optional. The comparison date range of this report. If unspecified, the
report will not have any comparison metrics.
Generated from protobuf field <code>optional .google.ads.admanager.v1.Report.DateRange comparison_date_range = 9 [(.google.api.field_behavior) = OPTIONAL];</code>
@param \Google\Ads\AdManager\V1\Report\DateRange $var
@return $this | setComparisonDateRange | php | googleapis/google-cloud-php | AdsAdManager/src/V1/ReportDefinition.php | https://github.com/googleapis/google-cloud-php/blob/master/AdsAdManager/src/V1/ReportDefinition.php | Apache-2.0 |
public function getCustomDimensionKeyIds()
{
return $this->custom_dimension_key_ids;
} | Optional. Custom Dimension keys that represent CUSTOM_DIMENSION_*
dimensions. The index of this repeated field corresponds to the index on
each dimension. For example, custom_dimension_key_ids[0] describes
CUSTOM_DIMENSION_0_VALUE_ID and CUSTOM_DIMENSION_0_VALUE.
Generated from protobuf field <code>repeated int64 custom_dimension_key_ids = 7 [(.google.api.field_behavior) = OPTIONAL];</code>
@return \Google\Protobuf\Internal\RepeatedField | getCustomDimensionKeyIds | php | googleapis/google-cloud-php | AdsAdManager/src/V1/ReportDefinition.php | https://github.com/googleapis/google-cloud-php/blob/master/AdsAdManager/src/V1/ReportDefinition.php | Apache-2.0 |
Subsets and Splits
No community queries yet
The top public SQL queries from the community will appear here once available.