code
stringlengths 17
247k
| 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 setCommon($var)
{
GPBUtil::checkMessage($var, \Google\Api\CommonLanguageSettings::class);
$this->common = $var;
return $this;
} | Some settings.
Generated from protobuf field <code>.google.api.CommonLanguageSettings common = 1;</code>
@param \Google\Api\CommonLanguageSettings $var
@return $this | setCommon | php | googleapis/google-cloud-php | CommonProtos/src/Api/RubySettings.php | https://github.com/googleapis/google-cloud-php/blob/master/CommonProtos/src/Api/RubySettings.php | Apache-2.0 |
public function getBackupCollections()
{
return $this->backup_collections;
} | A list of backupCollections in the project.
If the `location_id` in the parent field of the request is "-", all regions
available to the project are queried, and the results aggregated.
If in such an aggregated query a location is unavailable, a placeholder
backupCollection entry is included in the response with the `name` field
set to a value of the form
`projects/{project_id}/locations/{location_id}/backupCollections/`- and the
`status` field set to ERROR and `status_message` field set to "location not
available for ListBackupCollections".
Generated from protobuf field <code>repeated .google.cloud.redis.cluster.v1.BackupCollection backup_collections = 1;</code>
@return \Google\Protobuf\Internal\RepeatedField | getBackupCollections | php | googleapis/google-cloud-php | RedisCluster/src/V1/ListBackupCollectionsResponse.php | https://github.com/googleapis/google-cloud-php/blob/master/RedisCluster/src/V1/ListBackupCollectionsResponse.php | Apache-2.0 |
public function setBackupCollections($var)
{
$arr = GPBUtil::checkRepeatedField($var, \Google\Protobuf\Internal\GPBType::MESSAGE, \Google\Cloud\Redis\Cluster\V1\BackupCollection::class);
$this->backup_collections = $arr;
return $this;
} | A list of backupCollections in the project.
If the `location_id` in the parent field of the request is "-", all regions
available to the project are queried, and the results aggregated.
If in such an aggregated query a location is unavailable, a placeholder
backupCollection entry is included in the response with the `name` field
set to a value of the form
`projects/{project_id}/locations/{location_id}/backupCollections/`- and the
`status` field set to ERROR and `status_message` field set to "location not
available for ListBackupCollections".
Generated from protobuf field <code>repeated .google.cloud.redis.cluster.v1.BackupCollection backup_collections = 1;</code>
@param array<\Google\Cloud\Redis\Cluster\V1\BackupCollection>|\Google\Protobuf\Internal\RepeatedField $var
@return $this | setBackupCollections | php | googleapis/google-cloud-php | RedisCluster/src/V1/ListBackupCollectionsResponse.php | https://github.com/googleapis/google-cloud-php/blob/master/RedisCluster/src/V1/ListBackupCollectionsResponse.php | Apache-2.0 |
public function getTransitionRouteGroups()
{
return $this->transition_route_groups;
} | The list of transition route groups. There will be a maximum number of
items returned based on the page_size field in the request. The list may in
some cases be empty or contain fewer entries than page_size even if this
isn't the last page.
Generated from protobuf field <code>repeated .google.cloud.dialogflow.cx.v3.TransitionRouteGroup transition_route_groups = 1;</code>
@return \Google\Protobuf\Internal\RepeatedField | getTransitionRouteGroups | php | googleapis/google-cloud-php | DialogflowCx/src/V3/ListTransitionRouteGroupsResponse.php | https://github.com/googleapis/google-cloud-php/blob/master/DialogflowCx/src/V3/ListTransitionRouteGroupsResponse.php | Apache-2.0 |
public function setTransitionRouteGroups($var)
{
$arr = GPBUtil::checkRepeatedField($var, \Google\Protobuf\Internal\GPBType::MESSAGE, \Google\Cloud\Dialogflow\Cx\V3\TransitionRouteGroup::class);
$this->transition_route_groups = $arr;
return $this;
} | The list of transition route groups. There will be a maximum number of
items returned based on the page_size field in the request. The list may in
some cases be empty or contain fewer entries than page_size even if this
isn't the last page.
Generated from protobuf field <code>repeated .google.cloud.dialogflow.cx.v3.TransitionRouteGroup transition_route_groups = 1;</code>
@param array<\Google\Cloud\Dialogflow\Cx\V3\TransitionRouteGroup>|\Google\Protobuf\Internal\RepeatedField $var
@return $this | setTransitionRouteGroups | php | googleapis/google-cloud-php | DialogflowCx/src/V3/ListTransitionRouteGroupsResponse.php | https://github.com/googleapis/google-cloud-php/blob/master/DialogflowCx/src/V3/ListTransitionRouteGroupsResponse.php | Apache-2.0 |
public function getCanDefer()
{
@trigger_error('can_defer is deprecated.', E_USER_DEPRECATED);
return $this->can_defer;
} | Generated from protobuf field <code>bool can_defer = 2 [deprecated = true];</code>
@return bool
@deprecated | getCanDefer | php | googleapis/google-cloud-php | SqlAdmin/src/V1/DatabaseInstance/SqlScheduledMaintenance.php | https://github.com/googleapis/google-cloud-php/blob/master/SqlAdmin/src/V1/DatabaseInstance/SqlScheduledMaintenance.php | Apache-2.0 |
public function setCanDefer($var)
{
@trigger_error('can_defer is deprecated.', E_USER_DEPRECATED);
GPBUtil::checkBool($var);
$this->can_defer = $var;
return $this;
} | Generated from protobuf field <code>bool can_defer = 2 [deprecated = true];</code>
@param bool $var
@return $this
@deprecated | setCanDefer | php | googleapis/google-cloud-php | SqlAdmin/src/V1/DatabaseInstance/SqlScheduledMaintenance.php | https://github.com/googleapis/google-cloud-php/blob/master/SqlAdmin/src/V1/DatabaseInstance/SqlScheduledMaintenance.php | Apache-2.0 |
public function getCanReschedule()
{
return $this->can_reschedule;
} | If the scheduled maintenance can be rescheduled.
Generated from protobuf field <code>bool can_reschedule = 3;</code>
@return bool | getCanReschedule | php | googleapis/google-cloud-php | SqlAdmin/src/V1/DatabaseInstance/SqlScheduledMaintenance.php | https://github.com/googleapis/google-cloud-php/blob/master/SqlAdmin/src/V1/DatabaseInstance/SqlScheduledMaintenance.php | Apache-2.0 |
public function setCanReschedule($var)
{
GPBUtil::checkBool($var);
$this->can_reschedule = $var;
return $this;
} | If the scheduled maintenance can be rescheduled.
Generated from protobuf field <code>bool can_reschedule = 3;</code>
@param bool $var
@return $this | setCanReschedule | php | googleapis/google-cloud-php | SqlAdmin/src/V1/DatabaseInstance/SqlScheduledMaintenance.php | https://github.com/googleapis/google-cloud-php/blob/master/SqlAdmin/src/V1/DatabaseInstance/SqlScheduledMaintenance.php | Apache-2.0 |
public function getScheduleDeadlineTime()
{
return $this->schedule_deadline_time;
} | Maintenance cannot be rescheduled to start beyond this deadline.
Generated from protobuf field <code>optional .google.protobuf.Timestamp schedule_deadline_time = 4;</code>
@return \Google\Protobuf\Timestamp|null | getScheduleDeadlineTime | php | googleapis/google-cloud-php | SqlAdmin/src/V1/DatabaseInstance/SqlScheduledMaintenance.php | https://github.com/googleapis/google-cloud-php/blob/master/SqlAdmin/src/V1/DatabaseInstance/SqlScheduledMaintenance.php | Apache-2.0 |
public function setScheduleDeadlineTime($var)
{
GPBUtil::checkMessage($var, \Google\Protobuf\Timestamp::class);
$this->schedule_deadline_time = $var;
return $this;
} | Maintenance cannot be rescheduled to start beyond this deadline.
Generated from protobuf field <code>optional .google.protobuf.Timestamp schedule_deadline_time = 4;</code>
@param \Google\Protobuf\Timestamp $var
@return $this | setScheduleDeadlineTime | php | googleapis/google-cloud-php | SqlAdmin/src/V1/DatabaseInstance/SqlScheduledMaintenance.php | https://github.com/googleapis/google-cloud-php/blob/master/SqlAdmin/src/V1/DatabaseInstance/SqlScheduledMaintenance.php | Apache-2.0 |
public function setSnippet($var)
{
GPBUtil::checkString($var, True);
$this->snippet = $var;
return $this;
} | The relevant snippet of the article.
Generated from protobuf field <code>string snippet = 3;</code>
@param string $var
@return $this | setSnippet | php | googleapis/google-cloud-php | Dialogflow/src/V2/SearchKnowledgeAnswer/AnswerSource.php | https://github.com/googleapis/google-cloud-php/blob/master/Dialogflow/src/V2/SearchKnowledgeAnswer/AnswerSource.php | Apache-2.0 |
public function setPages($var)
{
$arr = GPBUtil::checkRepeatedField($var, \Google\Protobuf\Internal\GPBType::INT32);
$this->pages = $arr;
return $this;
} | Optional. Indices of the pages (starting from 1).
Generated from protobuf field <code>repeated int32 pages = 1 [(.google.api.field_behavior) = OPTIONAL];</code>
@param array<int>|\Google\Protobuf\Internal\RepeatedField $var
@return $this | setPages | php | googleapis/google-cloud-php | DocumentAi/src/V1/ProcessOptions/IndividualPageSelector.php | https://github.com/googleapis/google-cloud-php/blob/master/DocumentAi/src/V1/ProcessOptions/IndividualPageSelector.php | Apache-2.0 |
public function getMaxAttempts()
{
return $this->max_attempts;
} | Number of attempts per task.
Cloud Tasks will attempt the task `max_attempts` times (that is, if the
first attempt fails, then there will be `max_attempts - 1` retries). Must
be >= -1.
If unspecified when the queue is created, Cloud Tasks will pick the
default.
-1 indicates unlimited attempts.
This field has the same meaning as
[task_retry_limit in
queue.yaml/xml](https://cloud.google.com/appengine/docs/standard/python/config/queueref#retry_parameters).
Generated from protobuf field <code>int32 max_attempts = 1;</code>
@return int | getMaxAttempts | php | googleapis/google-cloud-php | Tasks/src/V2/RetryConfig.php | https://github.com/googleapis/google-cloud-php/blob/master/Tasks/src/V2/RetryConfig.php | Apache-2.0 |
public function setMaxAttempts($var)
{
GPBUtil::checkInt32($var);
$this->max_attempts = $var;
return $this;
} | Number of attempts per task.
Cloud Tasks will attempt the task `max_attempts` times (that is, if the
first attempt fails, then there will be `max_attempts - 1` retries). Must
be >= -1.
If unspecified when the queue is created, Cloud Tasks will pick the
default.
-1 indicates unlimited attempts.
This field has the same meaning as
[task_retry_limit in
queue.yaml/xml](https://cloud.google.com/appengine/docs/standard/python/config/queueref#retry_parameters).
Generated from protobuf field <code>int32 max_attempts = 1;</code>
@param int $var
@return $this | setMaxAttempts | php | googleapis/google-cloud-php | Tasks/src/V2/RetryConfig.php | https://github.com/googleapis/google-cloud-php/blob/master/Tasks/src/V2/RetryConfig.php | Apache-2.0 |
public function getMaxRetryDuration()
{
return $this->max_retry_duration;
} | If positive, `max_retry_duration` specifies the time limit for
retrying a failed task, measured from when the task was first
attempted. Once `max_retry_duration` time has passed *and* the
task has been attempted
[max_attempts][google.cloud.tasks.v2.RetryConfig.max_attempts] times, no
further attempts will be made and the task will be deleted.
If zero, then the task age is unlimited.
If unspecified when the queue is created, Cloud Tasks will pick the
default.
`max_retry_duration` will be truncated to the nearest second.
This field has the same meaning as
[task_age_limit in
queue.yaml/xml](https://cloud.google.com/appengine/docs/standard/python/config/queueref#retry_parameters).
Generated from protobuf field <code>.google.protobuf.Duration max_retry_duration = 2;</code>
@return \Google\Protobuf\Duration|null | getMaxRetryDuration | php | googleapis/google-cloud-php | Tasks/src/V2/RetryConfig.php | https://github.com/googleapis/google-cloud-php/blob/master/Tasks/src/V2/RetryConfig.php | Apache-2.0 |
public function setMaxRetryDuration($var)
{
GPBUtil::checkMessage($var, \Google\Protobuf\Duration::class);
$this->max_retry_duration = $var;
return $this;
} | If positive, `max_retry_duration` specifies the time limit for
retrying a failed task, measured from when the task was first
attempted. Once `max_retry_duration` time has passed *and* the
task has been attempted
[max_attempts][google.cloud.tasks.v2.RetryConfig.max_attempts] times, no
further attempts will be made and the task will be deleted.
If zero, then the task age is unlimited.
If unspecified when the queue is created, Cloud Tasks will pick the
default.
`max_retry_duration` will be truncated to the nearest second.
This field has the same meaning as
[task_age_limit in
queue.yaml/xml](https://cloud.google.com/appengine/docs/standard/python/config/queueref#retry_parameters).
Generated from protobuf field <code>.google.protobuf.Duration max_retry_duration = 2;</code>
@param \Google\Protobuf\Duration $var
@return $this | setMaxRetryDuration | php | googleapis/google-cloud-php | Tasks/src/V2/RetryConfig.php | https://github.com/googleapis/google-cloud-php/blob/master/Tasks/src/V2/RetryConfig.php | Apache-2.0 |
public function getMinBackoff()
{
return $this->min_backoff;
} | A task will be [scheduled][google.cloud.tasks.v2.Task.schedule_time] for
retry between [min_backoff][google.cloud.tasks.v2.RetryConfig.min_backoff]
and [max_backoff][google.cloud.tasks.v2.RetryConfig.max_backoff] duration
after it fails, if the queue's
[RetryConfig][google.cloud.tasks.v2.RetryConfig] specifies that the task
should be retried.
If unspecified when the queue is created, Cloud Tasks will pick the
default.
`min_backoff` will be truncated to the nearest second.
This field has the same meaning as
[min_backoff_seconds in
queue.yaml/xml](https://cloud.google.com/appengine/docs/standard/python/config/queueref#retry_parameters).
Generated from protobuf field <code>.google.protobuf.Duration min_backoff = 3;</code>
@return \Google\Protobuf\Duration|null | getMinBackoff | php | googleapis/google-cloud-php | Tasks/src/V2/RetryConfig.php | https://github.com/googleapis/google-cloud-php/blob/master/Tasks/src/V2/RetryConfig.php | Apache-2.0 |
public function setMinBackoff($var)
{
GPBUtil::checkMessage($var, \Google\Protobuf\Duration::class);
$this->min_backoff = $var;
return $this;
} | A task will be [scheduled][google.cloud.tasks.v2.Task.schedule_time] for
retry between [min_backoff][google.cloud.tasks.v2.RetryConfig.min_backoff]
and [max_backoff][google.cloud.tasks.v2.RetryConfig.max_backoff] duration
after it fails, if the queue's
[RetryConfig][google.cloud.tasks.v2.RetryConfig] specifies that the task
should be retried.
If unspecified when the queue is created, Cloud Tasks will pick the
default.
`min_backoff` will be truncated to the nearest second.
This field has the same meaning as
[min_backoff_seconds in
queue.yaml/xml](https://cloud.google.com/appengine/docs/standard/python/config/queueref#retry_parameters).
Generated from protobuf field <code>.google.protobuf.Duration min_backoff = 3;</code>
@param \Google\Protobuf\Duration $var
@return $this | setMinBackoff | php | googleapis/google-cloud-php | Tasks/src/V2/RetryConfig.php | https://github.com/googleapis/google-cloud-php/blob/master/Tasks/src/V2/RetryConfig.php | Apache-2.0 |
public function getMaxBackoff()
{
return $this->max_backoff;
} | A task will be [scheduled][google.cloud.tasks.v2.Task.schedule_time] for
retry between [min_backoff][google.cloud.tasks.v2.RetryConfig.min_backoff]
and [max_backoff][google.cloud.tasks.v2.RetryConfig.max_backoff] duration
after it fails, if the queue's
[RetryConfig][google.cloud.tasks.v2.RetryConfig] specifies that the task
should be retried.
If unspecified when the queue is created, Cloud Tasks will pick the
default.
`max_backoff` will be truncated to the nearest second.
This field has the same meaning as
[max_backoff_seconds in
queue.yaml/xml](https://cloud.google.com/appengine/docs/standard/python/config/queueref#retry_parameters).
Generated from protobuf field <code>.google.protobuf.Duration max_backoff = 4;</code>
@return \Google\Protobuf\Duration|null | getMaxBackoff | php | googleapis/google-cloud-php | Tasks/src/V2/RetryConfig.php | https://github.com/googleapis/google-cloud-php/blob/master/Tasks/src/V2/RetryConfig.php | Apache-2.0 |
public function setMaxBackoff($var)
{
GPBUtil::checkMessage($var, \Google\Protobuf\Duration::class);
$this->max_backoff = $var;
return $this;
} | A task will be [scheduled][google.cloud.tasks.v2.Task.schedule_time] for
retry between [min_backoff][google.cloud.tasks.v2.RetryConfig.min_backoff]
and [max_backoff][google.cloud.tasks.v2.RetryConfig.max_backoff] duration
after it fails, if the queue's
[RetryConfig][google.cloud.tasks.v2.RetryConfig] specifies that the task
should be retried.
If unspecified when the queue is created, Cloud Tasks will pick the
default.
`max_backoff` will be truncated to the nearest second.
This field has the same meaning as
[max_backoff_seconds in
queue.yaml/xml](https://cloud.google.com/appengine/docs/standard/python/config/queueref#retry_parameters).
Generated from protobuf field <code>.google.protobuf.Duration max_backoff = 4;</code>
@param \Google\Protobuf\Duration $var
@return $this | setMaxBackoff | php | googleapis/google-cloud-php | Tasks/src/V2/RetryConfig.php | https://github.com/googleapis/google-cloud-php/blob/master/Tasks/src/V2/RetryConfig.php | Apache-2.0 |
public function getMaxDoublings()
{
return $this->max_doublings;
} | The time between retries will double `max_doublings` times.
A task's retry interval starts at
[min_backoff][google.cloud.tasks.v2.RetryConfig.min_backoff], then doubles
`max_doublings` times, then increases linearly, and finally
retries at intervals of
[max_backoff][google.cloud.tasks.v2.RetryConfig.max_backoff] up to
[max_attempts][google.cloud.tasks.v2.RetryConfig.max_attempts] times.
For example, if
[min_backoff][google.cloud.tasks.v2.RetryConfig.min_backoff] is 10s,
[max_backoff][google.cloud.tasks.v2.RetryConfig.max_backoff] is 300s, and
`max_doublings` is 3, then the a task will first be retried in
10s. The retry interval will double three times, and then
increase linearly by 2^3 * 10s. Finally, the task will retry at
intervals of [max_backoff][google.cloud.tasks.v2.RetryConfig.max_backoff]
until the task has been attempted
[max_attempts][google.cloud.tasks.v2.RetryConfig.max_attempts] times. Thus,
the requests will retry at 10s, 20s, 40s, 80s, 160s, 240s, 300s, 300s, ....
If unspecified when the queue is created, Cloud Tasks will pick the
default.
This field has the same meaning as
[max_doublings in
queue.yaml/xml](https://cloud.google.com/appengine/docs/standard/python/config/queueref#retry_parameters).
Generated from protobuf field <code>int32 max_doublings = 5;</code>
@return int | getMaxDoublings | php | googleapis/google-cloud-php | Tasks/src/V2/RetryConfig.php | https://github.com/googleapis/google-cloud-php/blob/master/Tasks/src/V2/RetryConfig.php | Apache-2.0 |
public function setMaxDoublings($var)
{
GPBUtil::checkInt32($var);
$this->max_doublings = $var;
return $this;
} | The time between retries will double `max_doublings` times.
A task's retry interval starts at
[min_backoff][google.cloud.tasks.v2.RetryConfig.min_backoff], then doubles
`max_doublings` times, then increases linearly, and finally
retries at intervals of
[max_backoff][google.cloud.tasks.v2.RetryConfig.max_backoff] up to
[max_attempts][google.cloud.tasks.v2.RetryConfig.max_attempts] times.
For example, if
[min_backoff][google.cloud.tasks.v2.RetryConfig.min_backoff] is 10s,
[max_backoff][google.cloud.tasks.v2.RetryConfig.max_backoff] is 300s, and
`max_doublings` is 3, then the a task will first be retried in
10s. The retry interval will double three times, and then
increase linearly by 2^3 * 10s. Finally, the task will retry at
intervals of [max_backoff][google.cloud.tasks.v2.RetryConfig.max_backoff]
until the task has been attempted
[max_attempts][google.cloud.tasks.v2.RetryConfig.max_attempts] times. Thus,
the requests will retry at 10s, 20s, 40s, 80s, 160s, 240s, 300s, 300s, ....
If unspecified when the queue is created, Cloud Tasks will pick the
default.
This field has the same meaning as
[max_doublings in
queue.yaml/xml](https://cloud.google.com/appengine/docs/standard/python/config/queueref#retry_parameters).
Generated from protobuf field <code>int32 max_doublings = 5;</code>
@param int $var
@return $this | setMaxDoublings | php | googleapis/google-cloud-php | Tasks/src/V2/RetryConfig.php | https://github.com/googleapis/google-cloud-php/blob/master/Tasks/src/V2/RetryConfig.php | Apache-2.0 |
public function getResourceManagerTags()
{
return $this->resource_manager_tags;
} | Optional. Resource manager tags to be bound to the instance.
Generated from protobuf field <code>map<string, string> resource_manager_tags = 1 [(.google.api.field_behavior) = OPTIONAL];</code>
@return \Google\Protobuf\Internal\MapField | getResourceManagerTags | php | googleapis/google-cloud-php | BackupDr/src/V1/InstanceParams.php | https://github.com/googleapis/google-cloud-php/blob/master/BackupDr/src/V1/InstanceParams.php | Apache-2.0 |
public function setResourceManagerTags($var)
{
$arr = GPBUtil::checkMapField($var, \Google\Protobuf\Internal\GPBType::STRING, \Google\Protobuf\Internal\GPBType::STRING);
$this->resource_manager_tags = $arr;
return $this;
} | Optional. Resource manager tags to be bound to the instance.
Generated from protobuf field <code>map<string, string> resource_manager_tags = 1 [(.google.api.field_behavior) = OPTIONAL];</code>
@param array|\Google\Protobuf\Internal\MapField $var
@return $this | setResourceManagerTags | php | googleapis/google-cloud-php | BackupDr/src/V1/InstanceParams.php | https://github.com/googleapis/google-cloud-php/blob/master/BackupDr/src/V1/InstanceParams.php | Apache-2.0 |
public function getIntent()
{
return $this->intent;
} | The [Intent][google.cloud.dialogflow.cx.v3.Intent] that matched the query.
Some, not all fields are filled in this message, including but not limited
to: `name` and `display_name`. Only filled for
[`INTENT`][google.cloud.dialogflow.cx.v3.Match.MatchType] match type.
Generated from protobuf field <code>.google.cloud.dialogflow.cx.v3.Intent intent = 1;</code>
@return \Google\Cloud\Dialogflow\Cx\V3\Intent|null | getIntent | php | googleapis/google-cloud-php | DialogflowCx/src/V3/PBMatch.php | https://github.com/googleapis/google-cloud-php/blob/master/DialogflowCx/src/V3/PBMatch.php | Apache-2.0 |
public function setIntent($var)
{
GPBUtil::checkMessage($var, \Google\Cloud\Dialogflow\Cx\V3\Intent::class);
$this->intent = $var;
return $this;
} | The [Intent][google.cloud.dialogflow.cx.v3.Intent] that matched the query.
Some, not all fields are filled in this message, including but not limited
to: `name` and `display_name`. Only filled for
[`INTENT`][google.cloud.dialogflow.cx.v3.Match.MatchType] match type.
Generated from protobuf field <code>.google.cloud.dialogflow.cx.v3.Intent intent = 1;</code>
@param \Google\Cloud\Dialogflow\Cx\V3\Intent $var
@return $this | setIntent | php | googleapis/google-cloud-php | DialogflowCx/src/V3/PBMatch.php | https://github.com/googleapis/google-cloud-php/blob/master/DialogflowCx/src/V3/PBMatch.php | Apache-2.0 |
public function setParameters($var)
{
GPBUtil::checkMessage($var, \Google\Protobuf\Struct::class);
$this->parameters = $var;
return $this;
} | The collection of parameters extracted from the query.
Depending on your protocol or client library language, this is a
map, associative array, symbol table, dictionary, or JSON object
composed of a collection of (MapKey, MapValue) pairs:
* MapKey type: string
* MapKey value: parameter name
* MapValue type: If parameter's entity type is a composite entity then use
map, otherwise, depending on the parameter value type, it could be one of
string, number, boolean, null, list or map.
* MapValue value: If parameter's entity type is a composite entity then use
map from composite entity property names to property values, otherwise,
use parameter value.
Generated from protobuf field <code>.google.protobuf.Struct parameters = 2;</code>
@param \Google\Protobuf\Struct $var
@return $this | setParameters | php | googleapis/google-cloud-php | DialogflowCx/src/V3/PBMatch.php | https://github.com/googleapis/google-cloud-php/blob/master/DialogflowCx/src/V3/PBMatch.php | Apache-2.0 |
public function getResolvedInput()
{
return $this->resolved_input;
} | Final text input which was matched during MatchIntent. This value can be
different from original input sent in request because of spelling
correction or other processing.
Generated from protobuf field <code>string resolved_input = 3;</code>
@return string | getResolvedInput | php | googleapis/google-cloud-php | DialogflowCx/src/V3/PBMatch.php | https://github.com/googleapis/google-cloud-php/blob/master/DialogflowCx/src/V3/PBMatch.php | Apache-2.0 |
public function setResolvedInput($var)
{
GPBUtil::checkString($var, True);
$this->resolved_input = $var;
return $this;
} | Final text input which was matched during MatchIntent. This value can be
different from original input sent in request because of spelling
correction or other processing.
Generated from protobuf field <code>string resolved_input = 3;</code>
@param string $var
@return $this | setResolvedInput | php | googleapis/google-cloud-php | DialogflowCx/src/V3/PBMatch.php | https://github.com/googleapis/google-cloud-php/blob/master/DialogflowCx/src/V3/PBMatch.php | Apache-2.0 |
public function setMatchType($var)
{
GPBUtil::checkEnum($var, \Google\Cloud\Dialogflow\Cx\V3\PBMatch\MatchType::class);
$this->match_type = $var;
return $this;
} | Type of this [Match][google.cloud.dialogflow.cx.v3.Match].
Generated from protobuf field <code>.google.cloud.dialogflow.cx.v3.Match.MatchType match_type = 4;</code>
@param int $var
@return $this | setMatchType | php | googleapis/google-cloud-php | DialogflowCx/src/V3/PBMatch.php | https://github.com/googleapis/google-cloud-php/blob/master/DialogflowCx/src/V3/PBMatch.php | Apache-2.0 |
public function getTrainingMethod()
{
return $this->training_method;
} | Training method to use for CDE training.
Generated from protobuf field <code>.google.cloud.documentai.v1.TrainProcessorVersionRequest.CustomDocumentExtractionOptions.TrainingMethod training_method = 3;</code>
@return int | getTrainingMethod | php | googleapis/google-cloud-php | DocumentAi/src/V1/TrainProcessorVersionRequest/CustomDocumentExtractionOptions.php | https://github.com/googleapis/google-cloud-php/blob/master/DocumentAi/src/V1/TrainProcessorVersionRequest/CustomDocumentExtractionOptions.php | Apache-2.0 |
public function setTrainingMethod($var)
{
GPBUtil::checkEnum($var, \Google\Cloud\DocumentAI\V1\TrainProcessorVersionRequest\CustomDocumentExtractionOptions\TrainingMethod::class);
$this->training_method = $var;
return $this;
} | Training method to use for CDE training.
Generated from protobuf field <code>.google.cloud.documentai.v1.TrainProcessorVersionRequest.CustomDocumentExtractionOptions.TrainingMethod training_method = 3;</code>
@param int $var
@return $this | setTrainingMethod | php | googleapis/google-cloud-php | DocumentAi/src/V1/TrainProcessorVersionRequest/CustomDocumentExtractionOptions.php | https://github.com/googleapis/google-cloud-php/blob/master/DocumentAi/src/V1/TrainProcessorVersionRequest/CustomDocumentExtractionOptions.php | Apache-2.0 |
public function getRollout()
{
return $this->rollout;
} | Required. Name of the Rollout. Format is
`projects/{project}/locations/{location}/deliveryPipelines/{deliveryPipeline}/releases/{release}/rollouts/{rollout}`.
Generated from protobuf field <code>string rollout = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = {</code>
@return string | getRollout | php | googleapis/google-cloud-php | Deploy/src/V1/IgnoreJobRequest.php | https://github.com/googleapis/google-cloud-php/blob/master/Deploy/src/V1/IgnoreJobRequest.php | Apache-2.0 |
public function setRollout($var)
{
GPBUtil::checkString($var, True);
$this->rollout = $var;
return $this;
} | Required. Name of the Rollout. Format is
`projects/{project}/locations/{location}/deliveryPipelines/{deliveryPipeline}/releases/{release}/rollouts/{rollout}`.
Generated from protobuf field <code>string rollout = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = {</code>
@param string $var
@return $this | setRollout | php | googleapis/google-cloud-php | Deploy/src/V1/IgnoreJobRequest.php | https://github.com/googleapis/google-cloud-php/blob/master/Deploy/src/V1/IgnoreJobRequest.php | Apache-2.0 |
public function getPhaseId()
{
return $this->phase_id;
} | Required. The phase ID the Job to ignore belongs to.
Generated from protobuf field <code>string phase_id = 2 [(.google.api.field_behavior) = REQUIRED];</code>
@return string | getPhaseId | php | googleapis/google-cloud-php | Deploy/src/V1/IgnoreJobRequest.php | https://github.com/googleapis/google-cloud-php/blob/master/Deploy/src/V1/IgnoreJobRequest.php | Apache-2.0 |
public function setPhaseId($var)
{
GPBUtil::checkString($var, True);
$this->phase_id = $var;
return $this;
} | Required. The phase ID the Job to ignore belongs to.
Generated from protobuf field <code>string phase_id = 2 [(.google.api.field_behavior) = REQUIRED];</code>
@param string $var
@return $this | setPhaseId | php | googleapis/google-cloud-php | Deploy/src/V1/IgnoreJobRequest.php | https://github.com/googleapis/google-cloud-php/blob/master/Deploy/src/V1/IgnoreJobRequest.php | Apache-2.0 |
public function setInputConfig($var)
{
GPBUtil::checkMessage($var, \Google\Cloud\RecommendationEngine\V1beta1\InputConfig::class);
$this->input_config = $var;
return $this;
} | Required. The desired input location of the data.
Generated from protobuf field <code>.google.cloud.recommendationengine.v1beta1.InputConfig input_config = 3 [(.google.api.field_behavior) = REQUIRED];</code>
@param \Google\Cloud\RecommendationEngine\V1beta1\InputConfig $var
@return $this | setInputConfig | php | googleapis/google-cloud-php | RecommendationEngine/src/V1beta1/ImportUserEventsRequest.php | https://github.com/googleapis/google-cloud-php/blob/master/RecommendationEngine/src/V1beta1/ImportUserEventsRequest.php | Apache-2.0 |
public function getNetworkCode()
{
return $this->network_code;
} | Required. Ad Manager network code to associate with the VOD config.
Generated from protobuf field <code>string network_code = 1 [(.google.api.field_behavior) = REQUIRED];</code>
@return string | getNetworkCode | php | googleapis/google-cloud-php | VideoStitcher/src/V1/GamVodConfig.php | https://github.com/googleapis/google-cloud-php/blob/master/VideoStitcher/src/V1/GamVodConfig.php | Apache-2.0 |
public function setNetworkCode($var)
{
GPBUtil::checkString($var, True);
$this->network_code = $var;
return $this;
} | Required. Ad Manager network code to associate with the VOD config.
Generated from protobuf field <code>string network_code = 1 [(.google.api.field_behavior) = REQUIRED];</code>
@param string $var
@return $this | setNetworkCode | php | googleapis/google-cloud-php | VideoStitcher/src/V1/GamVodConfig.php | https://github.com/googleapis/google-cloud-php/blob/master/VideoStitcher/src/V1/GamVodConfig.php | Apache-2.0 |
public function getMaxResults()
{
return $this->max_results;
} | The maximum number of instances to return. The service may return fewer
than this value.
If unspecified, at most 500 instances are returned.
The maximum value is 1000; values above 1000 are coerced to 1000.
Generated from protobuf field <code>uint32 max_results = 2;</code>
@return int | getMaxResults | php | googleapis/google-cloud-php | SqlAdmin/src/V1/SqlInstancesListRequest.php | https://github.com/googleapis/google-cloud-php/blob/master/SqlAdmin/src/V1/SqlInstancesListRequest.php | Apache-2.0 |
public function getResourceData()
{
return $this->resource_data;
} | Optional. A representation of the Google Cloud resource. Should match the
Google Cloud resource JSON format.
Generated from protobuf field <code>.google.protobuf.Struct resource_data = 2 [(.google.api.field_behavior) = OPTIONAL];</code>
@return \Google\Protobuf\Struct|null | getResourceData | php | googleapis/google-cloud-php | SecurityCenter/src/V1/SimulateSecurityHealthAnalyticsCustomModuleRequest/SimulatedResource.php | https://github.com/googleapis/google-cloud-php/blob/master/SecurityCenter/src/V1/SimulateSecurityHealthAnalyticsCustomModuleRequest/SimulatedResource.php | Apache-2.0 |
public function setResourceData($var)
{
GPBUtil::checkMessage($var, \Google\Protobuf\Struct::class);
$this->resource_data = $var;
return $this;
} | Optional. A representation of the Google Cloud resource. Should match the
Google Cloud resource JSON format.
Generated from protobuf field <code>.google.protobuf.Struct resource_data = 2 [(.google.api.field_behavior) = OPTIONAL];</code>
@param \Google\Protobuf\Struct $var
@return $this | setResourceData | php | googleapis/google-cloud-php | SecurityCenter/src/V1/SimulateSecurityHealthAnalyticsCustomModuleRequest/SimulatedResource.php | https://github.com/googleapis/google-cloud-php/blob/master/SecurityCenter/src/V1/SimulateSecurityHealthAnalyticsCustomModuleRequest/SimulatedResource.php | Apache-2.0 |
public function getIamPolicyData()
{
return $this->iam_policy_data;
} | Optional. A representation of the IAM policy.
Generated from protobuf field <code>.google.iam.v1.Policy iam_policy_data = 3 [(.google.api.field_behavior) = OPTIONAL];</code>
@return \Google\Cloud\Iam\V1\Policy|null | getIamPolicyData | php | googleapis/google-cloud-php | SecurityCenter/src/V1/SimulateSecurityHealthAnalyticsCustomModuleRequest/SimulatedResource.php | https://github.com/googleapis/google-cloud-php/blob/master/SecurityCenter/src/V1/SimulateSecurityHealthAnalyticsCustomModuleRequest/SimulatedResource.php | Apache-2.0 |
public function setIamPolicyData($var)
{
GPBUtil::checkMessage($var, \Google\Cloud\Iam\V1\Policy::class);
$this->iam_policy_data = $var;
return $this;
} | Optional. A representation of the IAM policy.
Generated from protobuf field <code>.google.iam.v1.Policy iam_policy_data = 3 [(.google.api.field_behavior) = OPTIONAL];</code>
@param \Google\Cloud\Iam\V1\Policy $var
@return $this | setIamPolicyData | php | googleapis/google-cloud-php | SecurityCenter/src/V1/SimulateSecurityHealthAnalyticsCustomModuleRequest/SimulatedResource.php | https://github.com/googleapis/google-cloud-php/blob/master/SecurityCenter/src/V1/SimulateSecurityHealthAnalyticsCustomModuleRequest/SimulatedResource.php | Apache-2.0 |
public function setAllowedValues($var)
{
$arr = GPBUtil::checkRepeatedField($var, \Google\Protobuf\Internal\GPBType::STRING);
$this->allowed_values = $arr;
return $this;
} | The list of allowed values, if bounded. This field will be empty
if there is a unbounded number of allowed values.
Generated from protobuf field <code>repeated string allowed_values = 1;</code>
@param array<string>|\Google\Protobuf\Internal\RepeatedField $var
@return $this | setAllowedValues | php | googleapis/google-cloud-php | AlloyDb/src/V1/SupportedDatabaseFlag/StringRestrictions.php | https://github.com/googleapis/google-cloud-php/blob/master/AlloyDb/src/V1/SupportedDatabaseFlag/StringRestrictions.php | Apache-2.0 |
public function getTargetPage()
{
return $this->readOneof(2);
} | The target page to transition to.
Format:
`projects/<ProjectID>/locations/<LocationID>/agents/<AgentID>/flows/<FlowID>/pages/<PageID>`.
Generated from protobuf field <code>string target_page = 2 [(.google.api.resource_reference) = {</code>
@return string | getTargetPage | php | googleapis/google-cloud-php | DialogflowCx/src/V3/EventHandler.php | https://github.com/googleapis/google-cloud-php/blob/master/DialogflowCx/src/V3/EventHandler.php | Apache-2.0 |
public function setTargetPage($var)
{
GPBUtil::checkString($var, True);
$this->writeOneof(2, $var);
return $this;
} | The target page to transition to.
Format:
`projects/<ProjectID>/locations/<LocationID>/agents/<AgentID>/flows/<FlowID>/pages/<PageID>`.
Generated from protobuf field <code>string target_page = 2 [(.google.api.resource_reference) = {</code>
@param string $var
@return $this | setTargetPage | php | googleapis/google-cloud-php | DialogflowCx/src/V3/EventHandler.php | https://github.com/googleapis/google-cloud-php/blob/master/DialogflowCx/src/V3/EventHandler.php | Apache-2.0 |
public function getTargetFlow()
{
return $this->readOneof(3);
} | The target flow to transition to.
Format:
`projects/<ProjectID>/locations/<LocationID>/agents/<AgentID>/flows/<FlowID>`.
Generated from protobuf field <code>string target_flow = 3 [(.google.api.resource_reference) = {</code>
@return string | getTargetFlow | php | googleapis/google-cloud-php | DialogflowCx/src/V3/EventHandler.php | https://github.com/googleapis/google-cloud-php/blob/master/DialogflowCx/src/V3/EventHandler.php | Apache-2.0 |
public function setTargetFlow($var)
{
GPBUtil::checkString($var, True);
$this->writeOneof(3, $var);
return $this;
} | The target flow to transition to.
Format:
`projects/<ProjectID>/locations/<LocationID>/agents/<AgentID>/flows/<FlowID>`.
Generated from protobuf field <code>string target_flow = 3 [(.google.api.resource_reference) = {</code>
@param string $var
@return $this | setTargetFlow | php | googleapis/google-cloud-php | DialogflowCx/src/V3/EventHandler.php | https://github.com/googleapis/google-cloud-php/blob/master/DialogflowCx/src/V3/EventHandler.php | Apache-2.0 |
public function getBuilderConfig()
{
return $this->builder_config;
} | required
Generated from protobuf field <code>.grafeas.v1.BuilderConfig builder_config = 1;</code>
@return \Grafeas\V1\BuilderConfig|null | getBuilderConfig | php | googleapis/google-cloud-php | Grafeas/src/V1/InTotoProvenance.php | https://github.com/googleapis/google-cloud-php/blob/master/Grafeas/src/V1/InTotoProvenance.php | Apache-2.0 |
public function setBuilderConfig($var)
{
GPBUtil::checkMessage($var, \Grafeas\V1\BuilderConfig::class);
$this->builder_config = $var;
return $this;
} | required
Generated from protobuf field <code>.grafeas.v1.BuilderConfig builder_config = 1;</code>
@param \Grafeas\V1\BuilderConfig $var
@return $this | setBuilderConfig | php | googleapis/google-cloud-php | Grafeas/src/V1/InTotoProvenance.php | https://github.com/googleapis/google-cloud-php/blob/master/Grafeas/src/V1/InTotoProvenance.php | Apache-2.0 |
public function getRecipe()
{
return $this->recipe;
} | Identifies the configuration used for the build.
When combined with materials, this SHOULD fully describe the build,
such that re-running this recipe results in bit-for-bit identical output
(if the build is reproducible).
Generated from protobuf field <code>.grafeas.v1.Recipe recipe = 2;</code>
@return \Grafeas\V1\Recipe|null | getRecipe | php | googleapis/google-cloud-php | Grafeas/src/V1/InTotoProvenance.php | https://github.com/googleapis/google-cloud-php/blob/master/Grafeas/src/V1/InTotoProvenance.php | Apache-2.0 |
public function setRecipe($var)
{
GPBUtil::checkMessage($var, \Grafeas\V1\Recipe::class);
$this->recipe = $var;
return $this;
} | Identifies the configuration used for the build.
When combined with materials, this SHOULD fully describe the build,
such that re-running this recipe results in bit-for-bit identical output
(if the build is reproducible).
Generated from protobuf field <code>.grafeas.v1.Recipe recipe = 2;</code>
@param \Grafeas\V1\Recipe $var
@return $this | setRecipe | php | googleapis/google-cloud-php | Grafeas/src/V1/InTotoProvenance.php | https://github.com/googleapis/google-cloud-php/blob/master/Grafeas/src/V1/InTotoProvenance.php | Apache-2.0 |
public function setMetadata($var)
{
GPBUtil::checkMessage($var, \Grafeas\V1\Metadata::class);
$this->metadata = $var;
return $this;
} | Generated from protobuf field <code>.grafeas.v1.Metadata metadata = 3;</code>
@param \Grafeas\V1\Metadata $var
@return $this | setMetadata | php | googleapis/google-cloud-php | Grafeas/src/V1/InTotoProvenance.php | https://github.com/googleapis/google-cloud-php/blob/master/Grafeas/src/V1/InTotoProvenance.php | Apache-2.0 |
public function getMaterials()
{
return $this->materials;
} | The collection of artifacts that influenced the build including sources,
dependencies, build tools, base images, and so on. This is considered to be
incomplete unless metadata.completeness.materials is true. Unset or null is
equivalent to empty.
Generated from protobuf field <code>repeated string materials = 4;</code>
@return \Google\Protobuf\Internal\RepeatedField | getMaterials | php | googleapis/google-cloud-php | Grafeas/src/V1/InTotoProvenance.php | https://github.com/googleapis/google-cloud-php/blob/master/Grafeas/src/V1/InTotoProvenance.php | Apache-2.0 |
public function setMaterials($var)
{
$arr = GPBUtil::checkRepeatedField($var, \Google\Protobuf\Internal\GPBType::STRING);
$this->materials = $arr;
return $this;
} | The collection of artifacts that influenced the build including sources,
dependencies, build tools, base images, and so on. This is considered to be
incomplete unless metadata.completeness.materials is true. Unset or null is
equivalent to empty.
Generated from protobuf field <code>repeated string materials = 4;</code>
@param array<string>|\Google\Protobuf\Internal\RepeatedField $var
@return $this | setMaterials | php | googleapis/google-cloud-php | Grafeas/src/V1/InTotoProvenance.php | https://github.com/googleapis/google-cloud-php/blob/master/Grafeas/src/V1/InTotoProvenance.php | Apache-2.0 |
public function getPlayUri()
{
return $this->play_uri;
} | Output only. The URI to play the live session's ad-stitched stream.
Generated from protobuf field <code>string play_uri = 2 [(.google.api.field_behavior) = OUTPUT_ONLY];</code>
@return string | getPlayUri | php | googleapis/google-cloud-php | VideoStitcher/src/V1/LiveSession.php | https://github.com/googleapis/google-cloud-php/blob/master/VideoStitcher/src/V1/LiveSession.php | Apache-2.0 |
public function setPlayUri($var)
{
GPBUtil::checkString($var, True);
$this->play_uri = $var;
return $this;
} | Output only. The URI to play the live session's ad-stitched stream.
Generated from protobuf field <code>string play_uri = 2 [(.google.api.field_behavior) = OUTPUT_ONLY];</code>
@param string $var
@return $this | setPlayUri | php | googleapis/google-cloud-php | VideoStitcher/src/V1/LiveSession.php | https://github.com/googleapis/google-cloud-php/blob/master/VideoStitcher/src/V1/LiveSession.php | Apache-2.0 |
public function getAdTagMacros()
{
return $this->ad_tag_macros;
} | Key value pairs for ad tag macro replacement, only available for live
sessions that do not implement Google Ad manager ad insertion. If the
specified ad tag URI has macros, this field provides the mapping to the
value that will replace the macro in the ad tag URI.
Macros are designated by square brackets, for example:
Ad tag URI: "https://doubleclick.google.com/ad/1?geo_id=[geoId]"
Ad tag macros: `{"geoId": "123"}`
Fully qualified ad tag:
`"https://doubleclick.google.com/ad/1?geo_id=123"`
Generated from protobuf field <code>map<string, string> ad_tag_macros = 6;</code>
@return \Google\Protobuf\Internal\MapField | getAdTagMacros | php | googleapis/google-cloud-php | VideoStitcher/src/V1/LiveSession.php | https://github.com/googleapis/google-cloud-php/blob/master/VideoStitcher/src/V1/LiveSession.php | Apache-2.0 |
public function setAdTagMacros($var)
{
$arr = GPBUtil::checkMapField($var, \Google\Protobuf\Internal\GPBType::STRING, \Google\Protobuf\Internal\GPBType::STRING);
$this->ad_tag_macros = $arr;
return $this;
} | Key value pairs for ad tag macro replacement, only available for live
sessions that do not implement Google Ad manager ad insertion. If the
specified ad tag URI has macros, this field provides the mapping to the
value that will replace the macro in the ad tag URI.
Macros are designated by square brackets, for example:
Ad tag URI: "https://doubleclick.google.com/ad/1?geo_id=[geoId]"
Ad tag macros: `{"geoId": "123"}`
Fully qualified ad tag:
`"https://doubleclick.google.com/ad/1?geo_id=123"`
Generated from protobuf field <code>map<string, string> ad_tag_macros = 6;</code>
@param array|\Google\Protobuf\Internal\MapField $var
@return $this | setAdTagMacros | php | googleapis/google-cloud-php | VideoStitcher/src/V1/LiveSession.php | https://github.com/googleapis/google-cloud-php/blob/master/VideoStitcher/src/V1/LiveSession.php | Apache-2.0 |
public function getManifestOptions()
{
return $this->manifest_options;
} | Additional options that affect the output of the manifest.
Generated from protobuf field <code>.google.cloud.video.stitcher.v1.ManifestOptions manifest_options = 10;</code>
@return \Google\Cloud\Video\Stitcher\V1\ManifestOptions|null | getManifestOptions | php | googleapis/google-cloud-php | VideoStitcher/src/V1/LiveSession.php | https://github.com/googleapis/google-cloud-php/blob/master/VideoStitcher/src/V1/LiveSession.php | Apache-2.0 |
public function setManifestOptions($var)
{
GPBUtil::checkMessage($var, \Google\Cloud\Video\Stitcher\V1\ManifestOptions::class);
$this->manifest_options = $var;
return $this;
} | Additional options that affect the output of the manifest.
Generated from protobuf field <code>.google.cloud.video.stitcher.v1.ManifestOptions manifest_options = 10;</code>
@param \Google\Cloud\Video\Stitcher\V1\ManifestOptions $var
@return $this | setManifestOptions | php | googleapis/google-cloud-php | VideoStitcher/src/V1/LiveSession.php | https://github.com/googleapis/google-cloud-php/blob/master/VideoStitcher/src/V1/LiveSession.php | Apache-2.0 |
public function getGamSettings()
{
return $this->gam_settings;
} | This field should be set with appropriate values if GAM is being used for
ads.
Generated from protobuf field <code>.google.cloud.video.stitcher.v1.LiveSession.GamSettings gam_settings = 15;</code>
@return \Google\Cloud\Video\Stitcher\V1\LiveSession\GamSettings|null | getGamSettings | php | googleapis/google-cloud-php | VideoStitcher/src/V1/LiveSession.php | https://github.com/googleapis/google-cloud-php/blob/master/VideoStitcher/src/V1/LiveSession.php | Apache-2.0 |
public function setGamSettings($var)
{
GPBUtil::checkMessage($var, \Google\Cloud\Video\Stitcher\V1\LiveSession\GamSettings::class);
$this->gam_settings = $var;
return $this;
} | This field should be set with appropriate values if GAM is being used for
ads.
Generated from protobuf field <code>.google.cloud.video.stitcher.v1.LiveSession.GamSettings gam_settings = 15;</code>
@param \Google\Cloud\Video\Stitcher\V1\LiveSession\GamSettings $var
@return $this | setGamSettings | php | googleapis/google-cloud-php | VideoStitcher/src/V1/LiveSession.php | https://github.com/googleapis/google-cloud-php/blob/master/VideoStitcher/src/V1/LiveSession.php | Apache-2.0 |
public function getLiveConfig()
{
return $this->live_config;
} | Required. The resource name of the live config for this session, in the
form of `projects/{project}/locations/{location}/liveConfigs/{id}`.
Generated from protobuf field <code>string live_config = 16 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = {</code>
@return string | getLiveConfig | php | googleapis/google-cloud-php | VideoStitcher/src/V1/LiveSession.php | https://github.com/googleapis/google-cloud-php/blob/master/VideoStitcher/src/V1/LiveSession.php | Apache-2.0 |
public function setLiveConfig($var)
{
GPBUtil::checkString($var, True);
$this->live_config = $var;
return $this;
} | Required. The resource name of the live config for this session, in the
form of `projects/{project}/locations/{location}/liveConfigs/{id}`.
Generated from protobuf field <code>string live_config = 16 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = {</code>
@param string $var
@return $this | setLiveConfig | php | googleapis/google-cloud-php | VideoStitcher/src/V1/LiveSession.php | https://github.com/googleapis/google-cloud-php/blob/master/VideoStitcher/src/V1/LiveSession.php | Apache-2.0 |
public function getAdTracking()
{
return $this->ad_tracking;
} | Determines how the ad should be tracked. This overrides the value set in
the live config for this session.
Generated from protobuf field <code>.google.cloud.video.stitcher.v1.AdTracking ad_tracking = 17;</code>
@return int | getAdTracking | php | googleapis/google-cloud-php | VideoStitcher/src/V1/LiveSession.php | https://github.com/googleapis/google-cloud-php/blob/master/VideoStitcher/src/V1/LiveSession.php | Apache-2.0 |
public function setAdTracking($var)
{
GPBUtil::checkEnum($var, \Google\Cloud\Video\Stitcher\V1\AdTracking::class);
$this->ad_tracking = $var;
return $this;
} | Determines how the ad should be tracked. This overrides the value set in
the live config for this session.
Generated from protobuf field <code>.google.cloud.video.stitcher.v1.AdTracking ad_tracking = 17;</code>
@param int $var
@return $this | setAdTracking | php | googleapis/google-cloud-php | VideoStitcher/src/V1/LiveSession.php | https://github.com/googleapis/google-cloud-php/blob/master/VideoStitcher/src/V1/LiveSession.php | Apache-2.0 |
public function setParameters($var)
{
GPBUtil::checkMessage($var, \Google\Cloud\Memcache\V1\MemcacheParameters::class);
$this->parameters = $var;
return $this;
} | The parameters to apply to the instance.
Generated from protobuf field <code>.google.cloud.memcache.v1.MemcacheParameters parameters = 3;</code>
@param \Google\Cloud\Memcache\V1\MemcacheParameters $var
@return $this | setParameters | php | googleapis/google-cloud-php | Memcache/src/V1/UpdateParametersRequest.php | https://github.com/googleapis/google-cloud-php/blob/master/Memcache/src/V1/UpdateParametersRequest.php | Apache-2.0 |
public function getTransformationCount()
{
return $this->transformation_count;
} | Number of successfully applied transformations.
Generated from protobuf field <code>int64 transformation_count = 2;</code>
@return int|string | getTransformationCount | php | googleapis/google-cloud-php | Dlp/src/V2/DeidentifyDataSourceStats.php | https://github.com/googleapis/google-cloud-php/blob/master/Dlp/src/V2/DeidentifyDataSourceStats.php | Apache-2.0 |
public function setTransformationCount($var)
{
GPBUtil::checkInt64($var);
$this->transformation_count = $var;
return $this;
} | Number of successfully applied transformations.
Generated from protobuf field <code>int64 transformation_count = 2;</code>
@param int|string $var
@return $this | setTransformationCount | php | googleapis/google-cloud-php | Dlp/src/V2/DeidentifyDataSourceStats.php | https://github.com/googleapis/google-cloud-php/blob/master/Dlp/src/V2/DeidentifyDataSourceStats.php | Apache-2.0 |
public function getTransformationErrorCount()
{
return $this->transformation_error_count;
} | Number of errors encountered while trying to apply transformations.
Generated from protobuf field <code>int64 transformation_error_count = 3;</code>
@return int|string | getTransformationErrorCount | php | googleapis/google-cloud-php | Dlp/src/V2/DeidentifyDataSourceStats.php | https://github.com/googleapis/google-cloud-php/blob/master/Dlp/src/V2/DeidentifyDataSourceStats.php | Apache-2.0 |
public function setTransformationErrorCount($var)
{
GPBUtil::checkInt64($var);
$this->transformation_error_count = $var;
return $this;
} | Number of errors encountered while trying to apply transformations.
Generated from protobuf field <code>int64 transformation_error_count = 3;</code>
@param int|string $var
@return $this | setTransformationErrorCount | php | googleapis/google-cloud-php | Dlp/src/V2/DeidentifyDataSourceStats.php | https://github.com/googleapis/google-cloud-php/blob/master/Dlp/src/V2/DeidentifyDataSourceStats.php | Apache-2.0 |
public function getModel()
{
@trigger_error('model is deprecated.', E_USER_DEPRECATED);
return $this->model;
} | Optional. This field is now deprecated. Prefer the
[`model`][google.cloud.speech.v2.RecognitionConfig.model] field in the
[`RecognitionConfig`][google.cloud.speech.v2.RecognitionConfig] message.
Which model to use for recognition requests. Select the model best suited
to your domain to get best results.
Guidance for choosing which model to use can be found in the [Transcription
Models
Documentation](https://cloud.google.com/speech-to-text/v2/docs/transcription-model)
and the models supported in each region can be found in the [Table Of
Supported
Models](https://cloud.google.com/speech-to-text/v2/docs/speech-to-text-supported-languages).
Generated from protobuf field <code>string model = 4 [deprecated = true, (.google.api.field_behavior) = OPTIONAL];</code>
@return string
@deprecated | getModel | php | googleapis/google-cloud-php | Speech/src/V2/Recognizer.php | https://github.com/googleapis/google-cloud-php/blob/master/Speech/src/V2/Recognizer.php | Apache-2.0 |
public function setModel($var)
{
@trigger_error('model is deprecated.', E_USER_DEPRECATED);
GPBUtil::checkString($var, True);
$this->model = $var;
return $this;
} | Optional. This field is now deprecated. Prefer the
[`model`][google.cloud.speech.v2.RecognitionConfig.model] field in the
[`RecognitionConfig`][google.cloud.speech.v2.RecognitionConfig] message.
Which model to use for recognition requests. Select the model best suited
to your domain to get best results.
Guidance for choosing which model to use can be found in the [Transcription
Models
Documentation](https://cloud.google.com/speech-to-text/v2/docs/transcription-model)
and the models supported in each region can be found in the [Table Of
Supported
Models](https://cloud.google.com/speech-to-text/v2/docs/speech-to-text-supported-languages).
Generated from protobuf field <code>string model = 4 [deprecated = true, (.google.api.field_behavior) = OPTIONAL];</code>
@param string $var
@return $this
@deprecated | setModel | php | googleapis/google-cloud-php | Speech/src/V2/Recognizer.php | https://github.com/googleapis/google-cloud-php/blob/master/Speech/src/V2/Recognizer.php | Apache-2.0 |
public function getLanguageCodes()
{
@trigger_error('language_codes is deprecated.', E_USER_DEPRECATED);
return $this->language_codes;
} | Optional. This field is now deprecated. Prefer the
[`language_codes`][google.cloud.speech.v2.RecognitionConfig.language_codes]
field in the
[`RecognitionConfig`][google.cloud.speech.v2.RecognitionConfig] message.
The language of the supplied audio as a
[BCP-47](https://www.rfc-editor.org/rfc/bcp/bcp47.txt) language tag.
Supported languages for each model are listed in the [Table of Supported
Models](https://cloud.google.com/speech-to-text/v2/docs/speech-to-text-supported-languages).
If additional languages are provided, recognition result will contain
recognition in the most likely language detected. The recognition result
will include the language tag of the language detected in the audio.
When you create or update a Recognizer, these values are
stored in normalized BCP-47 form. For example, "en-us" is stored as
"en-US".
Generated from protobuf field <code>repeated string language_codes = 17 [deprecated = true, (.google.api.field_behavior) = OPTIONAL];</code>
@return \Google\Protobuf\Internal\RepeatedField
@deprecated | getLanguageCodes | php | googleapis/google-cloud-php | Speech/src/V2/Recognizer.php | https://github.com/googleapis/google-cloud-php/blob/master/Speech/src/V2/Recognizer.php | Apache-2.0 |
public function setLanguageCodes($var)
{
@trigger_error('language_codes is deprecated.', E_USER_DEPRECATED);
$arr = GPBUtil::checkRepeatedField($var, \Google\Protobuf\Internal\GPBType::STRING);
$this->language_codes = $arr;
return $this;
} | Optional. This field is now deprecated. Prefer the
[`language_codes`][google.cloud.speech.v2.RecognitionConfig.language_codes]
field in the
[`RecognitionConfig`][google.cloud.speech.v2.RecognitionConfig] message.
The language of the supplied audio as a
[BCP-47](https://www.rfc-editor.org/rfc/bcp/bcp47.txt) language tag.
Supported languages for each model are listed in the [Table of Supported
Models](https://cloud.google.com/speech-to-text/v2/docs/speech-to-text-supported-languages).
If additional languages are provided, recognition result will contain
recognition in the most likely language detected. The recognition result
will include the language tag of the language detected in the audio.
When you create or update a Recognizer, these values are
stored in normalized BCP-47 form. For example, "en-us" is stored as
"en-US".
Generated from protobuf field <code>repeated string language_codes = 17 [deprecated = true, (.google.api.field_behavior) = OPTIONAL];</code>
@param array<string>|\Google\Protobuf\Internal\RepeatedField $var
@return $this
@deprecated | setLanguageCodes | php | googleapis/google-cloud-php | Speech/src/V2/Recognizer.php | https://github.com/googleapis/google-cloud-php/blob/master/Speech/src/V2/Recognizer.php | Apache-2.0 |
public function getDefaultRecognitionConfig()
{
return $this->default_recognition_config;
} | Default configuration to use for requests with this Recognizer.
This can be overwritten by inline configuration in the
[RecognizeRequest.config][google.cloud.speech.v2.RecognizeRequest.config]
field.
Generated from protobuf field <code>.google.cloud.speech.v2.RecognitionConfig default_recognition_config = 6;</code>
@return \Google\Cloud\Speech\V2\RecognitionConfig|null | getDefaultRecognitionConfig | php | googleapis/google-cloud-php | Speech/src/V2/Recognizer.php | https://github.com/googleapis/google-cloud-php/blob/master/Speech/src/V2/Recognizer.php | Apache-2.0 |
public function setDefaultRecognitionConfig($var)
{
GPBUtil::checkMessage($var, \Google\Cloud\Speech\V2\RecognitionConfig::class);
$this->default_recognition_config = $var;
return $this;
} | Default configuration to use for requests with this Recognizer.
This can be overwritten by inline configuration in the
[RecognizeRequest.config][google.cloud.speech.v2.RecognizeRequest.config]
field.
Generated from protobuf field <code>.google.cloud.speech.v2.RecognitionConfig default_recognition_config = 6;</code>
@param \Google\Cloud\Speech\V2\RecognitionConfig $var
@return $this | setDefaultRecognitionConfig | php | googleapis/google-cloud-php | Speech/src/V2/Recognizer.php | https://github.com/googleapis/google-cloud-php/blob/master/Speech/src/V2/Recognizer.php | Apache-2.0 |
public function setState($var)
{
GPBUtil::checkEnum($var, \Google\Cloud\Speech\V2\Recognizer\State::class);
$this->state = $var;
return $this;
} | Output only. The Recognizer lifecycle state.
Generated from protobuf field <code>.google.cloud.speech.v2.Recognizer.State state = 8 [(.google.api.field_behavior) = OUTPUT_ONLY];</code>
@param int $var
@return $this | setState | php | googleapis/google-cloud-php | Speech/src/V2/Recognizer.php | https://github.com/googleapis/google-cloud-php/blob/master/Speech/src/V2/Recognizer.php | Apache-2.0 |
public function getEnableProducts()
{
return $this->enable_products;
} | Required. Enables or disables product crawling through the autofeed for the
given account. Autofeed accounts must meet [certain
conditions](https://support.google.com/merchants/answer/7538732#Configure_automated_feeds_Standard_Experience),
which can be checked through the `eligible` field.
The account must **not** be a marketplace.
When the autofeed is enabled for the first time, the products usually
appear instantly. When re-enabling, it might take up to 24 hours for
products to appear.
Generated from protobuf field <code>bool enable_products = 2 [(.google.api.field_behavior) = REQUIRED];</code>
@return bool | getEnableProducts | php | googleapis/google-cloud-php | ShoppingMerchantAccounts/src/V1beta/AutofeedSettings.php | https://github.com/googleapis/google-cloud-php/blob/master/ShoppingMerchantAccounts/src/V1beta/AutofeedSettings.php | Apache-2.0 |
public function setEnableProducts($var)
{
GPBUtil::checkBool($var);
$this->enable_products = $var;
return $this;
} | Required. Enables or disables product crawling through the autofeed for the
given account. Autofeed accounts must meet [certain
conditions](https://support.google.com/merchants/answer/7538732#Configure_automated_feeds_Standard_Experience),
which can be checked through the `eligible` field.
The account must **not** be a marketplace.
When the autofeed is enabled for the first time, the products usually
appear instantly. When re-enabling, it might take up to 24 hours for
products to appear.
Generated from protobuf field <code>bool enable_products = 2 [(.google.api.field_behavior) = REQUIRED];</code>
@param bool $var
@return $this | setEnableProducts | php | googleapis/google-cloud-php | ShoppingMerchantAccounts/src/V1beta/AutofeedSettings.php | https://github.com/googleapis/google-cloud-php/blob/master/ShoppingMerchantAccounts/src/V1beta/AutofeedSettings.php | Apache-2.0 |
public function getEligible()
{
return $this->eligible;
} | Output only. Determines whether merchant is eligible for being enrolled
into an autofeed.
Generated from protobuf field <code>bool eligible = 3 [(.google.api.field_behavior) = OUTPUT_ONLY];</code>
@return bool | getEligible | php | googleapis/google-cloud-php | ShoppingMerchantAccounts/src/V1beta/AutofeedSettings.php | https://github.com/googleapis/google-cloud-php/blob/master/ShoppingMerchantAccounts/src/V1beta/AutofeedSettings.php | Apache-2.0 |
public function setEligible($var)
{
GPBUtil::checkBool($var);
$this->eligible = $var;
return $this;
} | Output only. Determines whether merchant is eligible for being enrolled
into an autofeed.
Generated from protobuf field <code>bool eligible = 3 [(.google.api.field_behavior) = OUTPUT_ONLY];</code>
@param bool $var
@return $this | setEligible | php | googleapis/google-cloud-php | ShoppingMerchantAccounts/src/V1beta/AutofeedSettings.php | https://github.com/googleapis/google-cloud-php/blob/master/ShoppingMerchantAccounts/src/V1beta/AutofeedSettings.php | Apache-2.0 |
public function setRows($var)
{
$arr = GPBUtil::checkRepeatedField($var, \Google\Protobuf\Internal\GPBType::MESSAGE, \Google\Protobuf\Struct::class);
$this->rows = $arr;
return $this;
} | Each row hold a query result in the format of `Struct`.
Generated from protobuf field <code>repeated .google.protobuf.Struct rows = 1;</code>
@param array<\Google\Protobuf\Struct>|\Google\Protobuf\Internal\RepeatedField $var
@return $this | setRows | php | googleapis/google-cloud-php | Asset/src/V1/QueryResult.php | https://github.com/googleapis/google-cloud-php/blob/master/Asset/src/V1/QueryResult.php | Apache-2.0 |
public function setSchema($var)
{
GPBUtil::checkMessage($var, \Google\Cloud\Asset\V1\TableSchema::class);
$this->schema = $var;
return $this;
} | Describes the format of the [rows].
Generated from protobuf field <code>.google.cloud.asset.v1.TableSchema schema = 2;</code>
@param \Google\Cloud\Asset\V1\TableSchema $var
@return $this | setSchema | php | googleapis/google-cloud-php | Asset/src/V1/QueryResult.php | https://github.com/googleapis/google-cloud-php/blob/master/Asset/src/V1/QueryResult.php | Apache-2.0 |
public function getTotalRows()
{
return $this->total_rows;
} | Total rows of the whole query results.
Generated from protobuf field <code>int64 total_rows = 4;</code>
@return int|string | getTotalRows | php | googleapis/google-cloud-php | Asset/src/V1/QueryResult.php | https://github.com/googleapis/google-cloud-php/blob/master/Asset/src/V1/QueryResult.php | Apache-2.0 |
public function setTotalRows($var)
{
GPBUtil::checkInt64($var);
$this->total_rows = $var;
return $this;
} | Total rows of the whole query results.
Generated from protobuf field <code>int64 total_rows = 4;</code>
@param int|string $var
@return $this | setTotalRows | php | googleapis/google-cloud-php | Asset/src/V1/QueryResult.php | https://github.com/googleapis/google-cloud-php/blob/master/Asset/src/V1/QueryResult.php | Apache-2.0 |
public function getQaQuestion()
{
return $this->qa_question;
} | The QaQuestion answered by this answer.
Generated from protobuf field <code>string qa_question = 7 [(.google.api.resource_reference) = {</code>
@return string | getQaQuestion | php | googleapis/google-cloud-php | ContactCenterInsights/src/V1/QaAnswer.php | https://github.com/googleapis/google-cloud-php/blob/master/ContactCenterInsights/src/V1/QaAnswer.php | Apache-2.0 |
public function setQaQuestion($var)
{
GPBUtil::checkString($var, True);
$this->qa_question = $var;
return $this;
} | The QaQuestion answered by this answer.
Generated from protobuf field <code>string qa_question = 7 [(.google.api.resource_reference) = {</code>
@param string $var
@return $this | setQaQuestion | php | googleapis/google-cloud-php | ContactCenterInsights/src/V1/QaAnswer.php | https://github.com/googleapis/google-cloud-php/blob/master/ContactCenterInsights/src/V1/QaAnswer.php | Apache-2.0 |
public function getQuestionBody()
{
return $this->question_body;
} | Question text. E.g., "Did the agent greet the customer?"
Generated from protobuf field <code>string question_body = 6;</code>
@return string | getQuestionBody | php | googleapis/google-cloud-php | ContactCenterInsights/src/V1/QaAnswer.php | https://github.com/googleapis/google-cloud-php/blob/master/ContactCenterInsights/src/V1/QaAnswer.php | Apache-2.0 |
public function setQuestionBody($var)
{
GPBUtil::checkString($var, True);
$this->question_body = $var;
return $this;
} | Question text. E.g., "Did the agent greet the customer?"
Generated from protobuf field <code>string question_body = 6;</code>
@param string $var
@return $this | setQuestionBody | php | googleapis/google-cloud-php | ContactCenterInsights/src/V1/QaAnswer.php | https://github.com/googleapis/google-cloud-php/blob/master/ContactCenterInsights/src/V1/QaAnswer.php | Apache-2.0 |
public function getAnswerValue()
{
return $this->answer_value;
} | The main answer value, incorporating any manual edits if they exist.
Generated from protobuf field <code>.google.cloud.contactcenterinsights.v1.QaAnswer.AnswerValue answer_value = 3;</code>
@return \Google\Cloud\ContactCenterInsights\V1\QaAnswer\AnswerValue|null | getAnswerValue | php | googleapis/google-cloud-php | ContactCenterInsights/src/V1/QaAnswer.php | https://github.com/googleapis/google-cloud-php/blob/master/ContactCenterInsights/src/V1/QaAnswer.php | Apache-2.0 |
public function setAnswerValue($var)
{
GPBUtil::checkMessage($var, \Google\Cloud\ContactCenterInsights\V1\QaAnswer\AnswerValue::class);
$this->answer_value = $var;
return $this;
} | The main answer value, incorporating any manual edits if they exist.
Generated from protobuf field <code>.google.cloud.contactcenterinsights.v1.QaAnswer.AnswerValue answer_value = 3;</code>
@param \Google\Cloud\ContactCenterInsights\V1\QaAnswer\AnswerValue $var
@return $this | setAnswerValue | php | googleapis/google-cloud-php | ContactCenterInsights/src/V1/QaAnswer.php | https://github.com/googleapis/google-cloud-php/blob/master/ContactCenterInsights/src/V1/QaAnswer.php | Apache-2.0 |
public function getAnswerSources()
{
return $this->answer_sources;
} | List of all individual answers given to the question.
Generated from protobuf field <code>repeated .google.cloud.contactcenterinsights.v1.QaAnswer.AnswerSource answer_sources = 8;</code>
@return \Google\Protobuf\Internal\RepeatedField | getAnswerSources | php | googleapis/google-cloud-php | ContactCenterInsights/src/V1/QaAnswer.php | https://github.com/googleapis/google-cloud-php/blob/master/ContactCenterInsights/src/V1/QaAnswer.php | Apache-2.0 |
public function setAnswerSources($var)
{
$arr = GPBUtil::checkRepeatedField($var, \Google\Protobuf\Internal\GPBType::MESSAGE, \Google\Cloud\ContactCenterInsights\V1\QaAnswer\AnswerSource::class);
$this->answer_sources = $arr;
return $this;
} | List of all individual answers given to the question.
Generated from protobuf field <code>repeated .google.cloud.contactcenterinsights.v1.QaAnswer.AnswerSource answer_sources = 8;</code>
@param array<\Google\Cloud\ContactCenterInsights\V1\QaAnswer\AnswerSource>|\Google\Protobuf\Internal\RepeatedField $var
@return $this | setAnswerSources | php | googleapis/google-cloud-php | ContactCenterInsights/src/V1/QaAnswer.php | https://github.com/googleapis/google-cloud-php/blob/master/ContactCenterInsights/src/V1/QaAnswer.php | Apache-2.0 |
public function getLifecycleState()
{
return $this->lifecycle_state;
} | Output only. The current state of the Conversation.
Generated from protobuf field <code>.google.cloud.dialogflow.v2.Conversation.LifecycleState lifecycle_state = 2 [(.google.api.field_behavior) = OUTPUT_ONLY];</code>
@return int | getLifecycleState | php | googleapis/google-cloud-php | Dialogflow/src/V2/Conversation.php | https://github.com/googleapis/google-cloud-php/blob/master/Dialogflow/src/V2/Conversation.php | Apache-2.0 |
public function setLifecycleState($var)
{
GPBUtil::checkEnum($var, \Google\Cloud\Dialogflow\V2\Conversation\LifecycleState::class);
$this->lifecycle_state = $var;
return $this;
} | Output only. The current state of the Conversation.
Generated from protobuf field <code>.google.cloud.dialogflow.v2.Conversation.LifecycleState lifecycle_state = 2 [(.google.api.field_behavior) = OUTPUT_ONLY];</code>
@param int $var
@return $this | setLifecycleState | php | googleapis/google-cloud-php | Dialogflow/src/V2/Conversation.php | https://github.com/googleapis/google-cloud-php/blob/master/Dialogflow/src/V2/Conversation.php | Apache-2.0 |
public function setPhoneNumber($var)
{
GPBUtil::checkMessage($var, \Google\Cloud\Dialogflow\V2\ConversationPhoneNumber::class);
$this->phone_number = $var;
return $this;
} | Output only. It will not be empty if the conversation is to be connected
over telephony.
Generated from protobuf field <code>.google.cloud.dialogflow.v2.ConversationPhoneNumber phone_number = 4 [(.google.api.field_behavior) = OUTPUT_ONLY];</code>
@param \Google\Cloud\Dialogflow\V2\ConversationPhoneNumber $var
@return $this | setPhoneNumber | php | googleapis/google-cloud-php | Dialogflow/src/V2/Conversation.php | https://github.com/googleapis/google-cloud-php/blob/master/Dialogflow/src/V2/Conversation.php | Apache-2.0 |
Subsets and Splits
No community queries yet
The top public SQL queries from the community will appear here once available.