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 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 getName()
{
return $this->name;
} | Output only. Identifier. The resource name of the Recognizer.
Format: `projects/{project}/locations/{location}/recognizers/{recognizer}`.
Generated from protobuf field <code>string name = 1 [(.google.api.field_behavior) = OUTPUT_ONLY, (.google.api.field_behavior) = IDENTIFIER];</code>
@return string | getName | 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 setName($var)
{
GPBUtil::checkString($var, True);
$this->name = $var;
return $this;
} | Output only. Identifier. The resource name of the Recognizer.
Format: `projects/{project}/locations/{location}/recognizers/{recognizer}`.
Generated from protobuf field <code>string name = 1 [(.google.api.field_behavior) = OUTPUT_ONLY, (.google.api.field_behavior) = IDENTIFIER];</code>
@param string $var
@return $this | setName | 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 getUid()
{
return $this->uid;
} | Output only. System-assigned unique identifier for the Recognizer.
Generated from protobuf field <code>string uid = 2 [(.google.api.field_behavior) = OUTPUT_ONLY];</code>
@return string | getUid | 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 setUid($var)
{
GPBUtil::checkString($var, True);
$this->uid = $var;
return $this;
} | Output only. System-assigned unique identifier for the Recognizer.
Generated from protobuf field <code>string uid = 2 [(.google.api.field_behavior) = OUTPUT_ONLY];</code>
@param string $var
@return $this | setUid | 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 getDisplayName()
{
return $this->display_name;
} | User-settable, human-readable name for the Recognizer. Must be 63
characters or less.
Generated from protobuf field <code>string display_name = 3;</code>
@return string | getDisplayName | 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 setDisplayName($var)
{
GPBUtil::checkString($var, True);
$this->display_name = $var;
return $this;
} | User-settable, human-readable name for the Recognizer. Must be 63
characters or less.
Generated from protobuf field <code>string display_name = 3;</code>
@param string $var
@return $this | setDisplayName | 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 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 getAnnotations()
{
return $this->annotations;
} | Allows users to store small amounts of arbitrary data.
Both the key and the value must be 63 characters or less each.
At most 100 annotations.
Generated from protobuf field <code>map<string, string> annotations = 7;</code>
@return \Google\Protobuf\Internal\MapField | getAnnotations | 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 setAnnotations($var)
{
$arr = GPBUtil::checkMapField($var, \Google\Protobuf\Internal\GPBType::STRING, \Google\Protobuf\Internal\GPBType::STRING);
$this->annotations = $arr;
return $this;
} | Allows users to store small amounts of arbitrary data.
Both the key and the value must be 63 characters or less each.
At most 100 annotations.
Generated from protobuf field <code>map<string, string> annotations = 7;</code>
@param array|\Google\Protobuf\Internal\MapField $var
@return $this | setAnnotations | 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 getState()
{
return $this->state;
} | 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>
@return int | getState | 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 getCreateTime()
{
return $this->create_time;
} | Output only. Creation time.
Generated from protobuf field <code>.google.protobuf.Timestamp create_time = 9 [(.google.api.field_behavior) = OUTPUT_ONLY];</code>
@return \Google\Protobuf\Timestamp|null | getCreateTime | 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 setCreateTime($var)
{
GPBUtil::checkMessage($var, \Google\Protobuf\Timestamp::class);
$this->create_time = $var;
return $this;
} | Output only. Creation time.
Generated from protobuf field <code>.google.protobuf.Timestamp create_time = 9 [(.google.api.field_behavior) = OUTPUT_ONLY];</code>
@param \Google\Protobuf\Timestamp $var
@return $this | setCreateTime | 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 getUpdateTime()
{
return $this->update_time;
} | Output only. The most recent time this Recognizer was modified.
Generated from protobuf field <code>.google.protobuf.Timestamp update_time = 10 [(.google.api.field_behavior) = OUTPUT_ONLY];</code>
@return \Google\Protobuf\Timestamp|null | getUpdateTime | 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 setUpdateTime($var)
{
GPBUtil::checkMessage($var, \Google\Protobuf\Timestamp::class);
$this->update_time = $var;
return $this;
} | Output only. The most recent time this Recognizer was modified.
Generated from protobuf field <code>.google.protobuf.Timestamp update_time = 10 [(.google.api.field_behavior) = OUTPUT_ONLY];</code>
@param \Google\Protobuf\Timestamp $var
@return $this | setUpdateTime | 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 getDeleteTime()
{
return $this->delete_time;
} | Output only. The time at which this Recognizer was requested for deletion.
Generated from protobuf field <code>.google.protobuf.Timestamp delete_time = 11 [(.google.api.field_behavior) = OUTPUT_ONLY];</code>
@return \Google\Protobuf\Timestamp|null | getDeleteTime | 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 setDeleteTime($var)
{
GPBUtil::checkMessage($var, \Google\Protobuf\Timestamp::class);
$this->delete_time = $var;
return $this;
} | Output only. The time at which this Recognizer was requested for deletion.
Generated from protobuf field <code>.google.protobuf.Timestamp delete_time = 11 [(.google.api.field_behavior) = OUTPUT_ONLY];</code>
@param \Google\Protobuf\Timestamp $var
@return $this | setDeleteTime | 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 getExpireTime()
{
return $this->expire_time;
} | Output only. The time at which this Recognizer will be purged.
Generated from protobuf field <code>.google.protobuf.Timestamp expire_time = 14 [(.google.api.field_behavior) = OUTPUT_ONLY];</code>
@return \Google\Protobuf\Timestamp|null | getExpireTime | 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 setExpireTime($var)
{
GPBUtil::checkMessage($var, \Google\Protobuf\Timestamp::class);
$this->expire_time = $var;
return $this;
} | Output only. The time at which this Recognizer will be purged.
Generated from protobuf field <code>.google.protobuf.Timestamp expire_time = 14 [(.google.api.field_behavior) = OUTPUT_ONLY];</code>
@param \Google\Protobuf\Timestamp $var
@return $this | setExpireTime | 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 getEtag()
{
return $this->etag;
} | Output only. This checksum is computed by the server based on the value of
other fields. This may be sent on update, undelete, and delete requests to
ensure the client has an up-to-date value before proceeding.
Generated from protobuf field <code>string etag = 12 [(.google.api.field_behavior) = OUTPUT_ONLY];</code>
@return string | getEtag | 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 setEtag($var)
{
GPBUtil::checkString($var, True);
$this->etag = $var;
return $this;
} | Output only. This checksum is computed by the server based on the value of
other fields. This may be sent on update, undelete, and delete requests to
ensure the client has an up-to-date value before proceeding.
Generated from protobuf field <code>string etag = 12 [(.google.api.field_behavior) = OUTPUT_ONLY];</code>
@param string $var
@return $this | setEtag | 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 getReconciling()
{
return $this->reconciling;
} | Output only. Whether or not this Recognizer is in the process of being
updated.
Generated from protobuf field <code>bool reconciling = 13 [(.google.api.field_behavior) = OUTPUT_ONLY];</code>
@return bool | getReconciling | 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 setReconciling($var)
{
GPBUtil::checkBool($var);
$this->reconciling = $var;
return $this;
} | Output only. Whether or not this Recognizer is in the process of being
updated.
Generated from protobuf field <code>bool reconciling = 13 [(.google.api.field_behavior) = OUTPUT_ONLY];</code>
@param bool $var
@return $this | setReconciling | 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 getKmsKeyName()
{
return $this->kms_key_name;
} | Output only. The [KMS key
name](https://cloud.google.com/kms/docs/resource-hierarchy#keys) with which
the Recognizer is encrypted. The expected format is
`projects/{project}/locations/{location}/keyRings/{key_ring}/cryptoKeys/{crypto_key}`.
Generated from protobuf field <code>string kms_key_name = 15 [(.google.api.field_behavior) = OUTPUT_ONLY, (.google.api.resource_reference) = {</code>
@return string | getKmsKeyName | 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 setKmsKeyName($var)
{
GPBUtil::checkString($var, True);
$this->kms_key_name = $var;
return $this;
} | Output only. The [KMS key
name](https://cloud.google.com/kms/docs/resource-hierarchy#keys) with which
the Recognizer is encrypted. The expected format is
`projects/{project}/locations/{location}/keyRings/{key_ring}/cryptoKeys/{crypto_key}`.
Generated from protobuf field <code>string kms_key_name = 15 [(.google.api.field_behavior) = OUTPUT_ONLY, (.google.api.resource_reference) = {</code>
@param string $var
@return $this | setKmsKeyName | 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 getKmsKeyVersionName()
{
return $this->kms_key_version_name;
} | Output only. The [KMS key version
name](https://cloud.google.com/kms/docs/resource-hierarchy#key_versions)
with which the Recognizer is encrypted. The expected format is
`projects/{project}/locations/{location}/keyRings/{key_ring}/cryptoKeys/{crypto_key}/cryptoKeyVersions/{crypto_key_version}`.
Generated from protobuf field <code>string kms_key_version_name = 16 [(.google.api.field_behavior) = OUTPUT_ONLY, (.google.api.resource_reference) = {</code>
@return string | getKmsKeyVersionName | 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 setKmsKeyVersionName($var)
{
GPBUtil::checkString($var, True);
$this->kms_key_version_name = $var;
return $this;
} | Output only. The [KMS key version
name](https://cloud.google.com/kms/docs/resource-hierarchy#key_versions)
with which the Recognizer is encrypted. The expected format is
`projects/{project}/locations/{location}/keyRings/{key_ring}/cryptoKeys/{crypto_key}/cryptoKeyVersions/{crypto_key_version}`.
Generated from protobuf field <code>string kms_key_version_name = 16 [(.google.api.field_behavior) = OUTPUT_ONLY, (.google.api.resource_reference) = {</code>
@param string $var
@return $this | setKmsKeyVersionName | 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 getName()
{
return $this->name;
} | Identifier. The resource name of the autofeed settings.
Format: `accounts/{account}/autofeedSettings`.
Generated from protobuf field <code>string name = 1 [(.google.api.field_behavior) = IDENTIFIER];</code>
@return string | getName | 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 setName($var)
{
GPBUtil::checkString($var, True);
$this->name = $var;
return $this;
} | Identifier. The resource name of the autofeed settings.
Format: `accounts/{account}/autofeedSettings`.
Generated from protobuf field <code>string name = 1 [(.google.api.field_behavior) = IDENTIFIER];</code>
@param string $var
@return $this | setName | 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 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 getRows()
{
return $this->rows;
} | Each row hold a query result in the format of `Struct`.
Generated from protobuf field <code>repeated .google.protobuf.Struct rows = 1;</code>
@return \Google\Protobuf\Internal\RepeatedField | getRows | 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 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 getSchema()
{
return $this->schema;
} | Describes the format of the [rows].
Generated from protobuf field <code>.google.cloud.asset.v1.TableSchema schema = 2;</code>
@return \Google\Cloud\Asset\V1\TableSchema|null | getSchema | 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 getNextPageToken()
{
return $this->next_page_token;
} | Token to retrieve the next page of the results.
Generated from protobuf field <code>string next_page_token = 3;</code>
@return string | getNextPageToken | 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 setNextPageToken($var)
{
GPBUtil::checkString($var, True);
$this->next_page_token = $var;
return $this;
} | Token to retrieve the next page of the results.
Generated from protobuf field <code>string next_page_token = 3;</code>
@param string $var
@return $this | setNextPageToken | 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 getName()
{
return $this->name;
} | Required. The name of the Pipeline to be deleted.
Generated from protobuf field <code>string name = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = {</code>
@return string | getName | php | googleapis/google-cloud-php | Eventarc/src/V1/DeletePipelineRequest.php | https://github.com/googleapis/google-cloud-php/blob/master/Eventarc/src/V1/DeletePipelineRequest.php | Apache-2.0 |
public function setName($var)
{
GPBUtil::checkString($var, True);
$this->name = $var;
return $this;
} | Required. The name of the Pipeline to be deleted.
Generated from protobuf field <code>string name = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = {</code>
@param string $var
@return $this | setName | php | googleapis/google-cloud-php | Eventarc/src/V1/DeletePipelineRequest.php | https://github.com/googleapis/google-cloud-php/blob/master/Eventarc/src/V1/DeletePipelineRequest.php | Apache-2.0 |
public function getEtag()
{
return $this->etag;
} | Optional. If provided, the Pipeline will only be deleted if the etag
matches the current etag on the resource.
Generated from protobuf field <code>string etag = 2 [(.google.api.field_behavior) = OPTIONAL];</code>
@return string | getEtag | php | googleapis/google-cloud-php | Eventarc/src/V1/DeletePipelineRequest.php | https://github.com/googleapis/google-cloud-php/blob/master/Eventarc/src/V1/DeletePipelineRequest.php | Apache-2.0 |
public function setEtag($var)
{
GPBUtil::checkString($var, True);
$this->etag = $var;
return $this;
} | Optional. If provided, the Pipeline will only be deleted if the etag
matches the current etag on the resource.
Generated from protobuf field <code>string etag = 2 [(.google.api.field_behavior) = OPTIONAL];</code>
@param string $var
@return $this | setEtag | php | googleapis/google-cloud-php | Eventarc/src/V1/DeletePipelineRequest.php | https://github.com/googleapis/google-cloud-php/blob/master/Eventarc/src/V1/DeletePipelineRequest.php | Apache-2.0 |
public function getAllowMissing()
{
return $this->allow_missing;
} | Optional. If set to true, and the Pipeline is not found, the request will
succeed but no action will be taken on the server.
Generated from protobuf field <code>bool allow_missing = 3 [(.google.api.field_behavior) = OPTIONAL];</code>
@return bool | getAllowMissing | php | googleapis/google-cloud-php | Eventarc/src/V1/DeletePipelineRequest.php | https://github.com/googleapis/google-cloud-php/blob/master/Eventarc/src/V1/DeletePipelineRequest.php | Apache-2.0 |
public function setAllowMissing($var)
{
GPBUtil::checkBool($var);
$this->allow_missing = $var;
return $this;
} | Optional. If set to true, and the Pipeline is not found, the request will
succeed but no action will be taken on the server.
Generated from protobuf field <code>bool allow_missing = 3 [(.google.api.field_behavior) = OPTIONAL];</code>
@param bool $var
@return $this | setAllowMissing | php | googleapis/google-cloud-php | Eventarc/src/V1/DeletePipelineRequest.php | https://github.com/googleapis/google-cloud-php/blob/master/Eventarc/src/V1/DeletePipelineRequest.php | Apache-2.0 |
public function getValidateOnly()
{
return $this->validate_only;
} | Optional. If set, validate the request and preview the review, but do not
post it.
Generated from protobuf field <code>bool validate_only = 4 [(.google.api.field_behavior) = OPTIONAL];</code>
@return bool | getValidateOnly | php | googleapis/google-cloud-php | Eventarc/src/V1/DeletePipelineRequest.php | https://github.com/googleapis/google-cloud-php/blob/master/Eventarc/src/V1/DeletePipelineRequest.php | Apache-2.0 |
public function setValidateOnly($var)
{
GPBUtil::checkBool($var);
$this->validate_only = $var;
return $this;
} | Optional. If set, validate the request and preview the review, but do not
post it.
Generated from protobuf field <code>bool validate_only = 4 [(.google.api.field_behavior) = OPTIONAL];</code>
@param bool $var
@return $this | setValidateOnly | php | googleapis/google-cloud-php | Eventarc/src/V1/DeletePipelineRequest.php | https://github.com/googleapis/google-cloud-php/blob/master/Eventarc/src/V1/DeletePipelineRequest.php | Apache-2.0 |
public function getName()
{
return isset($this->name) ? $this->name : '';
} | Name of metadata label. The name can have a maximum length of 1024 characters and must be at least 1 character long.
Generated from protobuf field <code>optional string name = 3373707;</code>
@return string | getName | php | googleapis/google-cloud-php | Compute/src/V1/MetadataFilterLabelMatch.php | https://github.com/googleapis/google-cloud-php/blob/master/Compute/src/V1/MetadataFilterLabelMatch.php | Apache-2.0 |
public function setName($var)
{
GPBUtil::checkString($var, True);
$this->name = $var;
return $this;
} | Name of metadata label. The name can have a maximum length of 1024 characters and must be at least 1 character long.
Generated from protobuf field <code>optional string name = 3373707;</code>
@param string $var
@return $this | setName | php | googleapis/google-cloud-php | Compute/src/V1/MetadataFilterLabelMatch.php | https://github.com/googleapis/google-cloud-php/blob/master/Compute/src/V1/MetadataFilterLabelMatch.php | Apache-2.0 |
public function getValue()
{
return isset($this->value) ? $this->value : '';
} | The value of the label must match the specified value. value can have a maximum length of 1024 characters.
Generated from protobuf field <code>optional string value = 111972721;</code>
@return string | getValue | php | googleapis/google-cloud-php | Compute/src/V1/MetadataFilterLabelMatch.php | https://github.com/googleapis/google-cloud-php/blob/master/Compute/src/V1/MetadataFilterLabelMatch.php | Apache-2.0 |
public function setValue($var)
{
GPBUtil::checkString($var, True);
$this->value = $var;
return $this;
} | The value of the label must match the specified value. value can have a maximum length of 1024 characters.
Generated from protobuf field <code>optional string value = 111972721;</code>
@param string $var
@return $this | setValue | php | googleapis/google-cloud-php | Compute/src/V1/MetadataFilterLabelMatch.php | https://github.com/googleapis/google-cloud-php/blob/master/Compute/src/V1/MetadataFilterLabelMatch.php | Apache-2.0 |
public function getFilter()
{
return isset($this->filter) ? $this->filter : '';
} | A filter expression that filters resources listed in the response. Most Compute resources support two types of filter expressions: expressions that support regular expressions and expressions that follow API improvement proposal AIP-160. These two types of filter expressions cannot be mixed in one request. If you want to use AIP-160, your expression must specify the field name, an operator, and the value that you want to use for filtering. The value must be a string, a number, or a boolean. The operator must be either `=`, `!=`, `>`, `<`, `<=`, `>=` or `:`. For example, if you are filtering Compute Engine instances, you can exclude instances named `example-instance` by specifying `name != example-instance`. The `:*` comparison can be used to test whether a key has been defined. For example, to find all objects with `owner` label use: ``` labels.owner:* ``` You can also filter nested fields. For example, you could specify `scheduling.automaticRestart = false` to include instances only if they are not scheduled for automatic restarts. You can use filtering on nested fields to filter based on resource labels. To filter on multiple expressions, provide each separate expression within parentheses. For example: ``` (scheduling.automaticRestart = true) (cpuPlatform = "Intel Skylake") ``` By default, each expression is an `AND` expression. However, you can include `AND` and `OR` expressions explicitly. For example: ``` (cpuPlatform = "Intel Skylake") OR (cpuPlatform = "Intel Broadwell") AND (scheduling.automaticRestart = true) ``` If you want to use a regular expression, use the `eq` (equal) or `ne` (not equal) operator against a single un-parenthesized expression with or without quotes or against multiple parenthesized expressions. Examples: `fieldname eq unquoted literal` `fieldname eq 'single quoted literal'` `fieldname eq "double quoted literal"` `(fieldname1 eq literal) (fieldname2 ne "literal")` The literal value is interpreted as a regular expression using Google RE2 library syntax. The literal value must match the entire field. For example, to filter for instances that do not end with name "instance", you would use `name ne .*instance`. You cannot combine constraints on multiple fields using regular expressions.
Generated from protobuf field <code>optional string filter = 336120696;</code>
@return string | getFilter | php | googleapis/google-cloud-php | Compute/src/V1/ListGlobalForwardingRulesRequest.php | https://github.com/googleapis/google-cloud-php/blob/master/Compute/src/V1/ListGlobalForwardingRulesRequest.php | Apache-2.0 |
public function setFilter($var)
{
GPBUtil::checkString($var, True);
$this->filter = $var;
return $this;
} | A filter expression that filters resources listed in the response. Most Compute resources support two types of filter expressions: expressions that support regular expressions and expressions that follow API improvement proposal AIP-160. These two types of filter expressions cannot be mixed in one request. If you want to use AIP-160, your expression must specify the field name, an operator, and the value that you want to use for filtering. The value must be a string, a number, or a boolean. The operator must be either `=`, `!=`, `>`, `<`, `<=`, `>=` or `:`. For example, if you are filtering Compute Engine instances, you can exclude instances named `example-instance` by specifying `name != example-instance`. The `:*` comparison can be used to test whether a key has been defined. For example, to find all objects with `owner` label use: ``` labels.owner:* ``` You can also filter nested fields. For example, you could specify `scheduling.automaticRestart = false` to include instances only if they are not scheduled for automatic restarts. You can use filtering on nested fields to filter based on resource labels. To filter on multiple expressions, provide each separate expression within parentheses. For example: ``` (scheduling.automaticRestart = true) (cpuPlatform = "Intel Skylake") ``` By default, each expression is an `AND` expression. However, you can include `AND` and `OR` expressions explicitly. For example: ``` (cpuPlatform = "Intel Skylake") OR (cpuPlatform = "Intel Broadwell") AND (scheduling.automaticRestart = true) ``` If you want to use a regular expression, use the `eq` (equal) or `ne` (not equal) operator against a single un-parenthesized expression with or without quotes or against multiple parenthesized expressions. Examples: `fieldname eq unquoted literal` `fieldname eq 'single quoted literal'` `fieldname eq "double quoted literal"` `(fieldname1 eq literal) (fieldname2 ne "literal")` The literal value is interpreted as a regular expression using Google RE2 library syntax. The literal value must match the entire field. For example, to filter for instances that do not end with name "instance", you would use `name ne .*instance`. You cannot combine constraints on multiple fields using regular expressions.
Generated from protobuf field <code>optional string filter = 336120696;</code>
@param string $var
@return $this | setFilter | php | googleapis/google-cloud-php | Compute/src/V1/ListGlobalForwardingRulesRequest.php | https://github.com/googleapis/google-cloud-php/blob/master/Compute/src/V1/ListGlobalForwardingRulesRequest.php | Apache-2.0 |
public function getMaxResults()
{
return isset($this->max_results) ? $this->max_results : 0;
} | The maximum number of results per page that should be returned. If the number of available results is larger than `maxResults`, Compute Engine returns a `nextPageToken` that can be used to get the next page of results in subsequent list requests. Acceptable values are `0` to `500`, inclusive. (Default: `500`)
Generated from protobuf field <code>optional uint32 max_results = 54715419;</code>
@return int | getMaxResults | php | googleapis/google-cloud-php | Compute/src/V1/ListGlobalForwardingRulesRequest.php | https://github.com/googleapis/google-cloud-php/blob/master/Compute/src/V1/ListGlobalForwardingRulesRequest.php | Apache-2.0 |
public function setMaxResults($var)
{
GPBUtil::checkUint32($var);
$this->max_results = $var;
return $this;
} | The maximum number of results per page that should be returned. If the number of available results is larger than `maxResults`, Compute Engine returns a `nextPageToken` that can be used to get the next page of results in subsequent list requests. Acceptable values are `0` to `500`, inclusive. (Default: `500`)
Generated from protobuf field <code>optional uint32 max_results = 54715419;</code>
@param int $var
@return $this | setMaxResults | php | googleapis/google-cloud-php | Compute/src/V1/ListGlobalForwardingRulesRequest.php | https://github.com/googleapis/google-cloud-php/blob/master/Compute/src/V1/ListGlobalForwardingRulesRequest.php | Apache-2.0 |
public function getOrderBy()
{
return isset($this->order_by) ? $this->order_by : '';
} | Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name. You can also sort results in descending order based on the creation timestamp using `orderBy="creationTimestamp desc"`. This sorts results based on the `creationTimestamp` field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first. Currently, only sorting by `name` or `creationTimestamp desc` is supported.
Generated from protobuf field <code>optional string order_by = 160562920;</code>
@return string | getOrderBy | php | googleapis/google-cloud-php | Compute/src/V1/ListGlobalForwardingRulesRequest.php | https://github.com/googleapis/google-cloud-php/blob/master/Compute/src/V1/ListGlobalForwardingRulesRequest.php | Apache-2.0 |
public function setOrderBy($var)
{
GPBUtil::checkString($var, True);
$this->order_by = $var;
return $this;
} | Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name. You can also sort results in descending order based on the creation timestamp using `orderBy="creationTimestamp desc"`. This sorts results based on the `creationTimestamp` field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first. Currently, only sorting by `name` or `creationTimestamp desc` is supported.
Generated from protobuf field <code>optional string order_by = 160562920;</code>
@param string $var
@return $this | setOrderBy | php | googleapis/google-cloud-php | Compute/src/V1/ListGlobalForwardingRulesRequest.php | https://github.com/googleapis/google-cloud-php/blob/master/Compute/src/V1/ListGlobalForwardingRulesRequest.php | Apache-2.0 |
public function getPageToken()
{
return isset($this->page_token) ? $this->page_token : '';
} | Specifies a page token to use. Set `pageToken` to the `nextPageToken` returned by a previous list request to get the next page of results.
Generated from protobuf field <code>optional string page_token = 19994697;</code>
@return string | getPageToken | php | googleapis/google-cloud-php | Compute/src/V1/ListGlobalForwardingRulesRequest.php | https://github.com/googleapis/google-cloud-php/blob/master/Compute/src/V1/ListGlobalForwardingRulesRequest.php | Apache-2.0 |
public function setPageToken($var)
{
GPBUtil::checkString($var, True);
$this->page_token = $var;
return $this;
} | Specifies a page token to use. Set `pageToken` to the `nextPageToken` returned by a previous list request to get the next page of results.
Generated from protobuf field <code>optional string page_token = 19994697;</code>
@param string $var
@return $this | setPageToken | php | googleapis/google-cloud-php | Compute/src/V1/ListGlobalForwardingRulesRequest.php | https://github.com/googleapis/google-cloud-php/blob/master/Compute/src/V1/ListGlobalForwardingRulesRequest.php | Apache-2.0 |
public function getProject()
{
return $this->project;
} | Project ID for this request.
Generated from protobuf field <code>string project = 227560217 [(.google.api.field_behavior) = REQUIRED];</code>
@return string | getProject | php | googleapis/google-cloud-php | Compute/src/V1/ListGlobalForwardingRulesRequest.php | https://github.com/googleapis/google-cloud-php/blob/master/Compute/src/V1/ListGlobalForwardingRulesRequest.php | Apache-2.0 |
public function setProject($var)
{
GPBUtil::checkString($var, True);
$this->project = $var;
return $this;
} | Project ID for this request.
Generated from protobuf field <code>string project = 227560217 [(.google.api.field_behavior) = REQUIRED];</code>
@param string $var
@return $this | setProject | php | googleapis/google-cloud-php | Compute/src/V1/ListGlobalForwardingRulesRequest.php | https://github.com/googleapis/google-cloud-php/blob/master/Compute/src/V1/ListGlobalForwardingRulesRequest.php | Apache-2.0 |
public function getReturnPartialSuccess()
{
return isset($this->return_partial_success) ? $this->return_partial_success : false;
} | Opt-in for partial success behavior which provides partial results in case of failure. The default value is false. For example, when partial success behavior is enabled, aggregatedList for a single zone scope either returns all resources in the zone or no resources, with an error code.
Generated from protobuf field <code>optional bool return_partial_success = 517198390;</code>
@return bool | getReturnPartialSuccess | php | googleapis/google-cloud-php | Compute/src/V1/ListGlobalForwardingRulesRequest.php | https://github.com/googleapis/google-cloud-php/blob/master/Compute/src/V1/ListGlobalForwardingRulesRequest.php | Apache-2.0 |
public function setReturnPartialSuccess($var)
{
GPBUtil::checkBool($var);
$this->return_partial_success = $var;
return $this;
} | Opt-in for partial success behavior which provides partial results in case of failure. The default value is false. For example, when partial success behavior is enabled, aggregatedList for a single zone scope either returns all resources in the zone or no resources, with an error code.
Generated from protobuf field <code>optional bool return_partial_success = 517198390;</code>
@param bool $var
@return $this | setReturnPartialSuccess | php | googleapis/google-cloud-php | Compute/src/V1/ListGlobalForwardingRulesRequest.php | https://github.com/googleapis/google-cloud-php/blob/master/Compute/src/V1/ListGlobalForwardingRulesRequest.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 getConversation()
{
return $this->conversation;
} | The conversation the answer applies to.
Generated from protobuf field <code>string conversation = 2 [(.google.api.resource_reference) = {</code>
@return string | getConversation | 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 setConversation($var)
{
GPBUtil::checkString($var, True);
$this->conversation = $var;
return $this;
} | The conversation the answer applies to.
Generated from protobuf field <code>string conversation = 2 [(.google.api.resource_reference) = {</code>
@param string $var
@return $this | setConversation | 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 getTags()
{
return $this->tags;
} | User-defined list of arbitrary tags. Matches the value from
QaScorecard.ScorecardQuestion.tags. Used for grouping/organization and
for weighting the score of each answer.
Generated from protobuf field <code>repeated string tags = 5;</code>
@return \Google\Protobuf\Internal\RepeatedField | getTags | 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 setTags($var)
{
$arr = GPBUtil::checkRepeatedField($var, \Google\Protobuf\Internal\GPBType::STRING);
$this->tags = $arr;
return $this;
} | User-defined list of arbitrary tags. Matches the value from
QaScorecard.ScorecardQuestion.tags. Used for grouping/organization and
for weighting the score of each answer.
Generated from protobuf field <code>repeated string tags = 5;</code>
@param array<string>|\Google\Protobuf\Internal\RepeatedField $var
@return $this | setTags | 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 getName()
{
return $this->name;
} | Output only. Identifier. The unique identifier of this conversation.
Format: `projects/<Project ID>/locations/<Location
ID>/conversations/<Conversation ID>`.
Generated from protobuf field <code>string name = 1 [(.google.api.field_behavior) = OUTPUT_ONLY, (.google.api.field_behavior) = IDENTIFIER];</code>
@return string | getName | 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 setName($var)
{
GPBUtil::checkString($var, True);
$this->name = $var;
return $this;
} | Output only. Identifier. The unique identifier of this conversation.
Format: `projects/<Project ID>/locations/<Location
ID>/conversations/<Conversation ID>`.
Generated from protobuf field <code>string name = 1 [(.google.api.field_behavior) = OUTPUT_ONLY, (.google.api.field_behavior) = IDENTIFIER];</code>
@param string $var
@return $this | setName | 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 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 getConversationProfile()
{
return $this->conversation_profile;
} | Required. The Conversation Profile to be used to configure this
Conversation. This field cannot be updated.
Format: `projects/<Project ID>/locations/<Location
ID>/conversationProfiles/<Conversation Profile ID>`.
Generated from protobuf field <code>string conversation_profile = 3 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = {</code>
@return string | getConversationProfile | 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 setConversationProfile($var)
{
GPBUtil::checkString($var, True);
$this->conversation_profile = $var;
return $this;
} | Required. The Conversation Profile to be used to configure this
Conversation. This field cannot be updated.
Format: `projects/<Project ID>/locations/<Location
ID>/conversationProfiles/<Conversation Profile ID>`.
Generated from protobuf field <code>string conversation_profile = 3 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = {</code>
@param string $var
@return $this | setConversationProfile | 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 getPhoneNumber()
{
return $this->phone_number;
} | 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>
@return \Google\Cloud\Dialogflow\V2\ConversationPhoneNumber|null | getPhoneNumber | 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 |
public function getStartTime()
{
return $this->start_time;
} | Output only. The time the conversation was started.
Generated from protobuf field <code>.google.protobuf.Timestamp start_time = 5 [(.google.api.field_behavior) = OUTPUT_ONLY];</code>
@return \Google\Protobuf\Timestamp|null | getStartTime | 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 setStartTime($var)
{
GPBUtil::checkMessage($var, \Google\Protobuf\Timestamp::class);
$this->start_time = $var;
return $this;
} | Output only. The time the conversation was started.
Generated from protobuf field <code>.google.protobuf.Timestamp start_time = 5 [(.google.api.field_behavior) = OUTPUT_ONLY];</code>
@param \Google\Protobuf\Timestamp $var
@return $this | setStartTime | 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 getEndTime()
{
return $this->end_time;
} | Output only. The time the conversation was finished.
Generated from protobuf field <code>.google.protobuf.Timestamp end_time = 6 [(.google.api.field_behavior) = OUTPUT_ONLY];</code>
@return \Google\Protobuf\Timestamp|null | getEndTime | 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 setEndTime($var)
{
GPBUtil::checkMessage($var, \Google\Protobuf\Timestamp::class);
$this->end_time = $var;
return $this;
} | Output only. The time the conversation was finished.
Generated from protobuf field <code>.google.protobuf.Timestamp end_time = 6 [(.google.api.field_behavior) = OUTPUT_ONLY];</code>
@param \Google\Protobuf\Timestamp $var
@return $this | setEndTime | 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 getTelephonyConnectionInfo()
{
return $this->telephony_connection_info;
} | Output only. The telephony connection information.
Generated from protobuf field <code>.google.cloud.dialogflow.v2.Conversation.TelephonyConnectionInfo telephony_connection_info = 10 [(.google.api.field_behavior) = OUTPUT_ONLY];</code>
@return \Google\Cloud\Dialogflow\V2\Conversation\TelephonyConnectionInfo|null | getTelephonyConnectionInfo | 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 setTelephonyConnectionInfo($var)
{
GPBUtil::checkMessage($var, \Google\Cloud\Dialogflow\V2\Conversation\TelephonyConnectionInfo::class);
$this->telephony_connection_info = $var;
return $this;
} | Output only. The telephony connection information.
Generated from protobuf field <code>.google.cloud.dialogflow.v2.Conversation.TelephonyConnectionInfo telephony_connection_info = 10 [(.google.api.field_behavior) = OUTPUT_ONLY];</code>
@param \Google\Cloud\Dialogflow\V2\Conversation\TelephonyConnectionInfo $var
@return $this | setTelephonyConnectionInfo | 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 getIngestedContextReferences()
{
return $this->ingested_context_references;
} | Output only. The context reference updates provided by external systems.
Generated from protobuf field <code>map<string, .google.cloud.dialogflow.v2.Conversation.ContextReference> ingested_context_references = 17 [(.google.api.field_behavior) = OUTPUT_ONLY];</code>
@return \Google\Protobuf\Internal\MapField | getIngestedContextReferences | 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 setIngestedContextReferences($var)
{
$arr = GPBUtil::checkMapField($var, \Google\Protobuf\Internal\GPBType::STRING, \Google\Protobuf\Internal\GPBType::MESSAGE, \Google\Cloud\Dialogflow\V2\Conversation\ContextReference::class);
$this->ingested_context_references = $arr;
return $this;
} | Output only. The context reference updates provided by external systems.
Generated from protobuf field <code>map<string, .google.cloud.dialogflow.v2.Conversation.ContextReference> ingested_context_references = 17 [(.google.api.field_behavior) = OUTPUT_ONLY];</code>
@param array|\Google\Protobuf\Internal\MapField $var
@return $this | setIngestedContextReferences | 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.