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 setCreateTime($var)
{
GPBUtil::checkMessage($var, \Google\Protobuf\Timestamp::class);
$this->create_time = $var;
return $this;
} | The time that the evaluation was created.
Generated from protobuf field <code>.google.protobuf.Timestamp create_time = 2;</code>
@param \Google\Protobuf\Timestamp $var
@return $this | setCreateTime | php | googleapis/google-cloud-php | DocumentAi/src/V1/Evaluation.php | https://github.com/googleapis/google-cloud-php/blob/master/DocumentAi/src/V1/Evaluation.php | Apache-2.0 |
public function getDocumentCounters()
{
return $this->document_counters;
} | Counters for the documents used in the evaluation.
Generated from protobuf field <code>.google.cloud.documentai.v1.Evaluation.Counters document_counters = 5;</code>
@return \Google\Cloud\DocumentAI\V1\Evaluation\Counters|null | getDocumentCounters | php | googleapis/google-cloud-php | DocumentAi/src/V1/Evaluation.php | https://github.com/googleapis/google-cloud-php/blob/master/DocumentAi/src/V1/Evaluation.php | Apache-2.0 |
public function setDocumentCounters($var)
{
GPBUtil::checkMessage($var, \Google\Cloud\DocumentAI\V1\Evaluation\Counters::class);
$this->document_counters = $var;
return $this;
} | Counters for the documents used in the evaluation.
Generated from protobuf field <code>.google.cloud.documentai.v1.Evaluation.Counters document_counters = 5;</code>
@param \Google\Cloud\DocumentAI\V1\Evaluation\Counters $var
@return $this | setDocumentCounters | php | googleapis/google-cloud-php | DocumentAi/src/V1/Evaluation.php | https://github.com/googleapis/google-cloud-php/blob/master/DocumentAi/src/V1/Evaluation.php | Apache-2.0 |
public function getAllEntitiesMetrics()
{
return $this->all_entities_metrics;
} | Metrics for all the entities in aggregate.
Generated from protobuf field <code>.google.cloud.documentai.v1.Evaluation.MultiConfidenceMetrics all_entities_metrics = 3;</code>
@return \Google\Cloud\DocumentAI\V1\Evaluation\MultiConfidenceMetrics|null | getAllEntitiesMetrics | php | googleapis/google-cloud-php | DocumentAi/src/V1/Evaluation.php | https://github.com/googleapis/google-cloud-php/blob/master/DocumentAi/src/V1/Evaluation.php | Apache-2.0 |
public function setAllEntitiesMetrics($var)
{
GPBUtil::checkMessage($var, \Google\Cloud\DocumentAI\V1\Evaluation\MultiConfidenceMetrics::class);
$this->all_entities_metrics = $var;
return $this;
} | Metrics for all the entities in aggregate.
Generated from protobuf field <code>.google.cloud.documentai.v1.Evaluation.MultiConfidenceMetrics all_entities_metrics = 3;</code>
@param \Google\Cloud\DocumentAI\V1\Evaluation\MultiConfidenceMetrics $var
@return $this | setAllEntitiesMetrics | php | googleapis/google-cloud-php | DocumentAi/src/V1/Evaluation.php | https://github.com/googleapis/google-cloud-php/blob/master/DocumentAi/src/V1/Evaluation.php | Apache-2.0 |
public function getEntityMetrics()
{
return $this->entity_metrics;
} | Metrics across confidence levels, for different entities.
Generated from protobuf field <code>map<string, .google.cloud.documentai.v1.Evaluation.MultiConfidenceMetrics> entity_metrics = 4;</code>
@return \Google\Protobuf\Internal\MapField | getEntityMetrics | php | googleapis/google-cloud-php | DocumentAi/src/V1/Evaluation.php | https://github.com/googleapis/google-cloud-php/blob/master/DocumentAi/src/V1/Evaluation.php | Apache-2.0 |
public function setEntityMetrics($var)
{
$arr = GPBUtil::checkMapField($var, \Google\Protobuf\Internal\GPBType::STRING, \Google\Protobuf\Internal\GPBType::MESSAGE, \Google\Cloud\DocumentAI\V1\Evaluation\MultiConfidenceMetrics::class);
$this->entity_metrics = $arr;
return $this;
} | Metrics across confidence levels, for different entities.
Generated from protobuf field <code>map<string, .google.cloud.documentai.v1.Evaluation.MultiConfidenceMetrics> entity_metrics = 4;</code>
@param array|\Google\Protobuf\Internal\MapField $var
@return $this | setEntityMetrics | php | googleapis/google-cloud-php | DocumentAi/src/V1/Evaluation.php | https://github.com/googleapis/google-cloud-php/blob/master/DocumentAi/src/V1/Evaluation.php | Apache-2.0 |
public function getKmsKeyName()
{
return $this->kms_key_name;
} | The KMS key name used for encryption.
Generated from protobuf field <code>string kms_key_name = 6;</code>
@return string | getKmsKeyName | php | googleapis/google-cloud-php | DocumentAi/src/V1/Evaluation.php | https://github.com/googleapis/google-cloud-php/blob/master/DocumentAi/src/V1/Evaluation.php | Apache-2.0 |
public function setKmsKeyName($var)
{
GPBUtil::checkString($var, True);
$this->kms_key_name = $var;
return $this;
} | The KMS key name used for encryption.
Generated from protobuf field <code>string kms_key_name = 6;</code>
@param string $var
@return $this | setKmsKeyName | php | googleapis/google-cloud-php | DocumentAi/src/V1/Evaluation.php | https://github.com/googleapis/google-cloud-php/blob/master/DocumentAi/src/V1/Evaluation.php | Apache-2.0 |
public function getKmsKeyVersionName()
{
return $this->kms_key_version_name;
} | The KMS key version with which data is encrypted.
Generated from protobuf field <code>string kms_key_version_name = 7;</code>
@return string | getKmsKeyVersionName | php | googleapis/google-cloud-php | DocumentAi/src/V1/Evaluation.php | https://github.com/googleapis/google-cloud-php/blob/master/DocumentAi/src/V1/Evaluation.php | Apache-2.0 |
public function setKmsKeyVersionName($var)
{
GPBUtil::checkString($var, True);
$this->kms_key_version_name = $var;
return $this;
} | The KMS key version with which data is encrypted.
Generated from protobuf field <code>string kms_key_version_name = 7;</code>
@param string $var
@return $this | setKmsKeyVersionName | php | googleapis/google-cloud-php | DocumentAi/src/V1/Evaluation.php | https://github.com/googleapis/google-cloud-php/blob/master/DocumentAi/src/V1/Evaluation.php | Apache-2.0 |
public function getName()
{
return $this->name;
} | Output only. The resource name of the ModelEvaluation.
Generated from protobuf field <code>string name = 1 [(.google.api.field_behavior) = OUTPUT_ONLY];</code>
@return string | getName | php | googleapis/google-cloud-php | AiPlatform/src/V1/ModelEvaluation.php | https://github.com/googleapis/google-cloud-php/blob/master/AiPlatform/src/V1/ModelEvaluation.php | Apache-2.0 |
public function setName($var)
{
GPBUtil::checkString($var, True);
$this->name = $var;
return $this;
} | Output only. The resource name of the ModelEvaluation.
Generated from protobuf field <code>string name = 1 [(.google.api.field_behavior) = OUTPUT_ONLY];</code>
@param string $var
@return $this | setName | php | googleapis/google-cloud-php | AiPlatform/src/V1/ModelEvaluation.php | https://github.com/googleapis/google-cloud-php/blob/master/AiPlatform/src/V1/ModelEvaluation.php | Apache-2.0 |
public function getDisplayName()
{
return $this->display_name;
} | The display name of the ModelEvaluation.
Generated from protobuf field <code>string display_name = 10;</code>
@return string | getDisplayName | php | googleapis/google-cloud-php | AiPlatform/src/V1/ModelEvaluation.php | https://github.com/googleapis/google-cloud-php/blob/master/AiPlatform/src/V1/ModelEvaluation.php | Apache-2.0 |
public function setDisplayName($var)
{
GPBUtil::checkString($var, True);
$this->display_name = $var;
return $this;
} | The display name of the ModelEvaluation.
Generated from protobuf field <code>string display_name = 10;</code>
@param string $var
@return $this | setDisplayName | php | googleapis/google-cloud-php | AiPlatform/src/V1/ModelEvaluation.php | https://github.com/googleapis/google-cloud-php/blob/master/AiPlatform/src/V1/ModelEvaluation.php | Apache-2.0 |
public function getMetricsSchemaUri()
{
return $this->metrics_schema_uri;
} | Points to a YAML file stored on Google Cloud Storage describing the
[metrics][google.cloud.aiplatform.v1.ModelEvaluation.metrics] of this
ModelEvaluation. The schema is defined as an OpenAPI 3.0.2 [Schema
Object](https://github.com/OAI/OpenAPI-Specification/blob/main/versions/3.0.2.md#schemaObject).
Generated from protobuf field <code>string metrics_schema_uri = 2;</code>
@return string | getMetricsSchemaUri | php | googleapis/google-cloud-php | AiPlatform/src/V1/ModelEvaluation.php | https://github.com/googleapis/google-cloud-php/blob/master/AiPlatform/src/V1/ModelEvaluation.php | Apache-2.0 |
public function setMetricsSchemaUri($var)
{
GPBUtil::checkString($var, True);
$this->metrics_schema_uri = $var;
return $this;
} | Points to a YAML file stored on Google Cloud Storage describing the
[metrics][google.cloud.aiplatform.v1.ModelEvaluation.metrics] of this
ModelEvaluation. The schema is defined as an OpenAPI 3.0.2 [Schema
Object](https://github.com/OAI/OpenAPI-Specification/blob/main/versions/3.0.2.md#schemaObject).
Generated from protobuf field <code>string metrics_schema_uri = 2;</code>
@param string $var
@return $this | setMetricsSchemaUri | php | googleapis/google-cloud-php | AiPlatform/src/V1/ModelEvaluation.php | https://github.com/googleapis/google-cloud-php/blob/master/AiPlatform/src/V1/ModelEvaluation.php | Apache-2.0 |
public function getMetrics()
{
return $this->metrics;
} | Evaluation metrics of the Model. The schema of the metrics is stored in
[metrics_schema_uri][google.cloud.aiplatform.v1.ModelEvaluation.metrics_schema_uri]
Generated from protobuf field <code>.google.protobuf.Value metrics = 3;</code>
@return \Google\Protobuf\Value|null | getMetrics | php | googleapis/google-cloud-php | AiPlatform/src/V1/ModelEvaluation.php | https://github.com/googleapis/google-cloud-php/blob/master/AiPlatform/src/V1/ModelEvaluation.php | Apache-2.0 |
public function setMetrics($var)
{
GPBUtil::checkMessage($var, \Google\Protobuf\Value::class);
$this->metrics = $var;
return $this;
} | Evaluation metrics of the Model. The schema of the metrics is stored in
[metrics_schema_uri][google.cloud.aiplatform.v1.ModelEvaluation.metrics_schema_uri]
Generated from protobuf field <code>.google.protobuf.Value metrics = 3;</code>
@param \Google\Protobuf\Value $var
@return $this | setMetrics | php | googleapis/google-cloud-php | AiPlatform/src/V1/ModelEvaluation.php | https://github.com/googleapis/google-cloud-php/blob/master/AiPlatform/src/V1/ModelEvaluation.php | Apache-2.0 |
public function getCreateTime()
{
return $this->create_time;
} | Output only. Timestamp when this ModelEvaluation was created.
Generated from protobuf field <code>.google.protobuf.Timestamp create_time = 4 [(.google.api.field_behavior) = OUTPUT_ONLY];</code>
@return \Google\Protobuf\Timestamp|null | getCreateTime | php | googleapis/google-cloud-php | AiPlatform/src/V1/ModelEvaluation.php | https://github.com/googleapis/google-cloud-php/blob/master/AiPlatform/src/V1/ModelEvaluation.php | Apache-2.0 |
public function setCreateTime($var)
{
GPBUtil::checkMessage($var, \Google\Protobuf\Timestamp::class);
$this->create_time = $var;
return $this;
} | Output only. Timestamp when this ModelEvaluation was created.
Generated from protobuf field <code>.google.protobuf.Timestamp create_time = 4 [(.google.api.field_behavior) = OUTPUT_ONLY];</code>
@param \Google\Protobuf\Timestamp $var
@return $this | setCreateTime | php | googleapis/google-cloud-php | AiPlatform/src/V1/ModelEvaluation.php | https://github.com/googleapis/google-cloud-php/blob/master/AiPlatform/src/V1/ModelEvaluation.php | Apache-2.0 |
public function getSliceDimensions()
{
return $this->slice_dimensions;
} | All possible
[dimensions][google.cloud.aiplatform.v1.ModelEvaluationSlice.Slice.dimension]
of ModelEvaluationSlices. The dimensions can be used as the filter of the
[ModelService.ListModelEvaluationSlices][google.cloud.aiplatform.v1.ModelService.ListModelEvaluationSlices]
request, in the form of `slice.dimension = <dimension>`.
Generated from protobuf field <code>repeated string slice_dimensions = 5;</code>
@return \Google\Protobuf\Internal\RepeatedField | getSliceDimensions | php | googleapis/google-cloud-php | AiPlatform/src/V1/ModelEvaluation.php | https://github.com/googleapis/google-cloud-php/blob/master/AiPlatform/src/V1/ModelEvaluation.php | Apache-2.0 |
public function setSliceDimensions($var)
{
$arr = GPBUtil::checkRepeatedField($var, \Google\Protobuf\Internal\GPBType::STRING);
$this->slice_dimensions = $arr;
return $this;
} | All possible
[dimensions][google.cloud.aiplatform.v1.ModelEvaluationSlice.Slice.dimension]
of ModelEvaluationSlices. The dimensions can be used as the filter of the
[ModelService.ListModelEvaluationSlices][google.cloud.aiplatform.v1.ModelService.ListModelEvaluationSlices]
request, in the form of `slice.dimension = <dimension>`.
Generated from protobuf field <code>repeated string slice_dimensions = 5;</code>
@param array<string>|\Google\Protobuf\Internal\RepeatedField $var
@return $this | setSliceDimensions | php | googleapis/google-cloud-php | AiPlatform/src/V1/ModelEvaluation.php | https://github.com/googleapis/google-cloud-php/blob/master/AiPlatform/src/V1/ModelEvaluation.php | Apache-2.0 |
public function getDataItemSchemaUri()
{
return $this->data_item_schema_uri;
} | Points to a YAML file stored on Google Cloud Storage describing
[EvaluatedDataItemView.data_item_payload][] and
[EvaluatedAnnotation.data_item_payload][google.cloud.aiplatform.v1.EvaluatedAnnotation.data_item_payload].
The schema is defined as an OpenAPI 3.0.2 [Schema
Object](https://github.com/OAI/OpenAPI-Specification/blob/main/versions/3.0.2.md#schemaObject).
This field is not populated if there are neither EvaluatedDataItemViews nor
EvaluatedAnnotations under this ModelEvaluation.
Generated from protobuf field <code>string data_item_schema_uri = 6;</code>
@return string | getDataItemSchemaUri | php | googleapis/google-cloud-php | AiPlatform/src/V1/ModelEvaluation.php | https://github.com/googleapis/google-cloud-php/blob/master/AiPlatform/src/V1/ModelEvaluation.php | Apache-2.0 |
public function setDataItemSchemaUri($var)
{
GPBUtil::checkString($var, True);
$this->data_item_schema_uri = $var;
return $this;
} | Points to a YAML file stored on Google Cloud Storage describing
[EvaluatedDataItemView.data_item_payload][] and
[EvaluatedAnnotation.data_item_payload][google.cloud.aiplatform.v1.EvaluatedAnnotation.data_item_payload].
The schema is defined as an OpenAPI 3.0.2 [Schema
Object](https://github.com/OAI/OpenAPI-Specification/blob/main/versions/3.0.2.md#schemaObject).
This field is not populated if there are neither EvaluatedDataItemViews nor
EvaluatedAnnotations under this ModelEvaluation.
Generated from protobuf field <code>string data_item_schema_uri = 6;</code>
@param string $var
@return $this | setDataItemSchemaUri | php | googleapis/google-cloud-php | AiPlatform/src/V1/ModelEvaluation.php | https://github.com/googleapis/google-cloud-php/blob/master/AiPlatform/src/V1/ModelEvaluation.php | Apache-2.0 |
public function getAnnotationSchemaUri()
{
return $this->annotation_schema_uri;
} | Points to a YAML file stored on Google Cloud Storage describing
[EvaluatedDataItemView.predictions][],
[EvaluatedDataItemView.ground_truths][],
[EvaluatedAnnotation.predictions][google.cloud.aiplatform.v1.EvaluatedAnnotation.predictions],
and
[EvaluatedAnnotation.ground_truths][google.cloud.aiplatform.v1.EvaluatedAnnotation.ground_truths].
The schema is defined as an OpenAPI 3.0.2 [Schema
Object](https://github.com/OAI/OpenAPI-Specification/blob/main/versions/3.0.2.md#schemaObject).
This field is not populated if there are neither EvaluatedDataItemViews nor
EvaluatedAnnotations under this ModelEvaluation.
Generated from protobuf field <code>string annotation_schema_uri = 7;</code>
@return string | getAnnotationSchemaUri | php | googleapis/google-cloud-php | AiPlatform/src/V1/ModelEvaluation.php | https://github.com/googleapis/google-cloud-php/blob/master/AiPlatform/src/V1/ModelEvaluation.php | Apache-2.0 |
public function setAnnotationSchemaUri($var)
{
GPBUtil::checkString($var, True);
$this->annotation_schema_uri = $var;
return $this;
} | Points to a YAML file stored on Google Cloud Storage describing
[EvaluatedDataItemView.predictions][],
[EvaluatedDataItemView.ground_truths][],
[EvaluatedAnnotation.predictions][google.cloud.aiplatform.v1.EvaluatedAnnotation.predictions],
and
[EvaluatedAnnotation.ground_truths][google.cloud.aiplatform.v1.EvaluatedAnnotation.ground_truths].
The schema is defined as an OpenAPI 3.0.2 [Schema
Object](https://github.com/OAI/OpenAPI-Specification/blob/main/versions/3.0.2.md#schemaObject).
This field is not populated if there are neither EvaluatedDataItemViews nor
EvaluatedAnnotations under this ModelEvaluation.
Generated from protobuf field <code>string annotation_schema_uri = 7;</code>
@param string $var
@return $this | setAnnotationSchemaUri | php | googleapis/google-cloud-php | AiPlatform/src/V1/ModelEvaluation.php | https://github.com/googleapis/google-cloud-php/blob/master/AiPlatform/src/V1/ModelEvaluation.php | Apache-2.0 |
public function getModelExplanation()
{
return $this->model_explanation;
} | Aggregated explanation metrics for the Model's prediction output over the
data this ModelEvaluation uses. This field is populated only if the Model
is evaluated with explanations, and only for AutoML tabular Models.
Generated from protobuf field <code>.google.cloud.aiplatform.v1.ModelExplanation model_explanation = 8;</code>
@return \Google\Cloud\AIPlatform\V1\ModelExplanation|null | getModelExplanation | php | googleapis/google-cloud-php | AiPlatform/src/V1/ModelEvaluation.php | https://github.com/googleapis/google-cloud-php/blob/master/AiPlatform/src/V1/ModelEvaluation.php | Apache-2.0 |
public function setModelExplanation($var)
{
GPBUtil::checkMessage($var, \Google\Cloud\AIPlatform\V1\ModelExplanation::class);
$this->model_explanation = $var;
return $this;
} | Aggregated explanation metrics for the Model's prediction output over the
data this ModelEvaluation uses. This field is populated only if the Model
is evaluated with explanations, and only for AutoML tabular Models.
Generated from protobuf field <code>.google.cloud.aiplatform.v1.ModelExplanation model_explanation = 8;</code>
@param \Google\Cloud\AIPlatform\V1\ModelExplanation $var
@return $this | setModelExplanation | php | googleapis/google-cloud-php | AiPlatform/src/V1/ModelEvaluation.php | https://github.com/googleapis/google-cloud-php/blob/master/AiPlatform/src/V1/ModelEvaluation.php | Apache-2.0 |
public function getExplanationSpecs()
{
return $this->explanation_specs;
} | Describes the values of
[ExplanationSpec][google.cloud.aiplatform.v1.ExplanationSpec] that are used
for explaining the predicted values on the evaluated data.
Generated from protobuf field <code>repeated .google.cloud.aiplatform.v1.ModelEvaluation.ModelEvaluationExplanationSpec explanation_specs = 9;</code>
@return \Google\Protobuf\Internal\RepeatedField | getExplanationSpecs | php | googleapis/google-cloud-php | AiPlatform/src/V1/ModelEvaluation.php | https://github.com/googleapis/google-cloud-php/blob/master/AiPlatform/src/V1/ModelEvaluation.php | Apache-2.0 |
public function setExplanationSpecs($var)
{
$arr = GPBUtil::checkRepeatedField($var, \Google\Protobuf\Internal\GPBType::MESSAGE, \Google\Cloud\AIPlatform\V1\ModelEvaluation\ModelEvaluationExplanationSpec::class);
$this->explanation_specs = $arr;
return $this;
} | Describes the values of
[ExplanationSpec][google.cloud.aiplatform.v1.ExplanationSpec] that are used
for explaining the predicted values on the evaluated data.
Generated from protobuf field <code>repeated .google.cloud.aiplatform.v1.ModelEvaluation.ModelEvaluationExplanationSpec explanation_specs = 9;</code>
@param array<\Google\Cloud\AIPlatform\V1\ModelEvaluation\ModelEvaluationExplanationSpec>|\Google\Protobuf\Internal\RepeatedField $var
@return $this | setExplanationSpecs | php | googleapis/google-cloud-php | AiPlatform/src/V1/ModelEvaluation.php | https://github.com/googleapis/google-cloud-php/blob/master/AiPlatform/src/V1/ModelEvaluation.php | Apache-2.0 |
public function getMetadata()
{
return $this->metadata;
} | The metadata of the ModelEvaluation.
For the ModelEvaluation uploaded from Managed Pipeline, metadata contains a
structured value with keys of "pipeline_job_id", "evaluation_dataset_type",
"evaluation_dataset_path", "row_based_metrics_path".
Generated from protobuf field <code>.google.protobuf.Value metadata = 11;</code>
@return \Google\Protobuf\Value|null | getMetadata | php | googleapis/google-cloud-php | AiPlatform/src/V1/ModelEvaluation.php | https://github.com/googleapis/google-cloud-php/blob/master/AiPlatform/src/V1/ModelEvaluation.php | Apache-2.0 |
public function setMetadata($var)
{
GPBUtil::checkMessage($var, \Google\Protobuf\Value::class);
$this->metadata = $var;
return $this;
} | The metadata of the ModelEvaluation.
For the ModelEvaluation uploaded from Managed Pipeline, metadata contains a
structured value with keys of "pipeline_job_id", "evaluation_dataset_type",
"evaluation_dataset_path", "row_based_metrics_path".
Generated from protobuf field <code>.google.protobuf.Value metadata = 11;</code>
@param \Google\Protobuf\Value $var
@return $this | setMetadata | php | googleapis/google-cloud-php | AiPlatform/src/V1/ModelEvaluation.php | https://github.com/googleapis/google-cloud-php/blob/master/AiPlatform/src/V1/ModelEvaluation.php | Apache-2.0 |
public function getName()
{
return $this->name;
} | Required. Package name.
Generated from protobuf field <code>string name = 1 [(.google.api.field_behavior) = REQUIRED];</code>
@return string | getName | php | googleapis/google-cloud-php | OsConfig/src/V1/OSPolicy/Resource/PackageResource/YUM.php | https://github.com/googleapis/google-cloud-php/blob/master/OsConfig/src/V1/OSPolicy/Resource/PackageResource/YUM.php | Apache-2.0 |
public function setName($var)
{
GPBUtil::checkString($var, True);
$this->name = $var;
return $this;
} | Required. Package name.
Generated from protobuf field <code>string name = 1 [(.google.api.field_behavior) = REQUIRED];</code>
@param string $var
@return $this | setName | php | googleapis/google-cloud-php | OsConfig/src/V1/OSPolicy/Resource/PackageResource/YUM.php | https://github.com/googleapis/google-cloud-php/blob/master/OsConfig/src/V1/OSPolicy/Resource/PackageResource/YUM.php | Apache-2.0 |
public function getDetectIntentResponseId()
{
return $this->detect_intent_response_id;
} | Always present. The unique identifier of the
[DetectIntentResponse][google.cloud.dialogflow.cx.v3.DetectIntentResponse]
that will be returned to the API caller.
Generated from protobuf field <code>string detect_intent_response_id = 1;</code>
@return string | getDetectIntentResponseId | php | googleapis/google-cloud-php | DialogflowCx/src/V3/WebhookRequest.php | https://github.com/googleapis/google-cloud-php/blob/master/DialogflowCx/src/V3/WebhookRequest.php | Apache-2.0 |
public function setDetectIntentResponseId($var)
{
GPBUtil::checkString($var, True);
$this->detect_intent_response_id = $var;
return $this;
} | Always present. The unique identifier of the
[DetectIntentResponse][google.cloud.dialogflow.cx.v3.DetectIntentResponse]
that will be returned to the API caller.
Generated from protobuf field <code>string detect_intent_response_id = 1;</code>
@param string $var
@return $this | setDetectIntentResponseId | php | googleapis/google-cloud-php | DialogflowCx/src/V3/WebhookRequest.php | https://github.com/googleapis/google-cloud-php/blob/master/DialogflowCx/src/V3/WebhookRequest.php | Apache-2.0 |
public function getText()
{
return $this->readOneof(10);
} | If [natural language text][google.cloud.dialogflow.cx.v3.TextInput] was
provided as input, this field will contain a copy of the text.
Generated from protobuf field <code>string text = 10;</code>
@return string | getText | php | googleapis/google-cloud-php | DialogflowCx/src/V3/WebhookRequest.php | https://github.com/googleapis/google-cloud-php/blob/master/DialogflowCx/src/V3/WebhookRequest.php | Apache-2.0 |
public function setText($var)
{
GPBUtil::checkString($var, True);
$this->writeOneof(10, $var);
return $this;
} | If [natural language text][google.cloud.dialogflow.cx.v3.TextInput] was
provided as input, this field will contain a copy of the text.
Generated from protobuf field <code>string text = 10;</code>
@param string $var
@return $this | setText | php | googleapis/google-cloud-php | DialogflowCx/src/V3/WebhookRequest.php | https://github.com/googleapis/google-cloud-php/blob/master/DialogflowCx/src/V3/WebhookRequest.php | Apache-2.0 |
public function getTriggerIntent()
{
return $this->readOneof(11);
} | If an [intent][google.cloud.dialogflow.cx.v3.IntentInput] was provided as
input, this field will contain a copy of the intent identifier. Format:
`projects/<ProjectID>/locations/<LocationID>/agents/<AgentID>/intents/<IntentID>`.
Generated from protobuf field <code>string trigger_intent = 11 [(.google.api.resource_reference) = {</code>
@return string | getTriggerIntent | php | googleapis/google-cloud-php | DialogflowCx/src/V3/WebhookRequest.php | https://github.com/googleapis/google-cloud-php/blob/master/DialogflowCx/src/V3/WebhookRequest.php | Apache-2.0 |
public function setTriggerIntent($var)
{
GPBUtil::checkString($var, True);
$this->writeOneof(11, $var);
return $this;
} | If an [intent][google.cloud.dialogflow.cx.v3.IntentInput] was provided as
input, this field will contain a copy of the intent identifier. Format:
`projects/<ProjectID>/locations/<LocationID>/agents/<AgentID>/intents/<IntentID>`.
Generated from protobuf field <code>string trigger_intent = 11 [(.google.api.resource_reference) = {</code>
@param string $var
@return $this | setTriggerIntent | php | googleapis/google-cloud-php | DialogflowCx/src/V3/WebhookRequest.php | https://github.com/googleapis/google-cloud-php/blob/master/DialogflowCx/src/V3/WebhookRequest.php | Apache-2.0 |
public function getTranscript()
{
return $this->readOneof(12);
} | If [natural language speech
audio][google.cloud.dialogflow.cx.v3.AudioInput] was provided as input,
this field will contain the transcript for the audio.
Generated from protobuf field <code>string transcript = 12;</code>
@return string | getTranscript | php | googleapis/google-cloud-php | DialogflowCx/src/V3/WebhookRequest.php | https://github.com/googleapis/google-cloud-php/blob/master/DialogflowCx/src/V3/WebhookRequest.php | Apache-2.0 |
public function setTranscript($var)
{
GPBUtil::checkString($var, True);
$this->writeOneof(12, $var);
return $this;
} | If [natural language speech
audio][google.cloud.dialogflow.cx.v3.AudioInput] was provided as input,
this field will contain the transcript for the audio.
Generated from protobuf field <code>string transcript = 12;</code>
@param string $var
@return $this | setTranscript | php | googleapis/google-cloud-php | DialogflowCx/src/V3/WebhookRequest.php | https://github.com/googleapis/google-cloud-php/blob/master/DialogflowCx/src/V3/WebhookRequest.php | Apache-2.0 |
public function getTriggerEvent()
{
return $this->readOneof(14);
} | If an [event][google.cloud.dialogflow.cx.v3.EventInput] was provided as
input, this field will contain the name of the event.
Generated from protobuf field <code>string trigger_event = 14;</code>
@return string | getTriggerEvent | php | googleapis/google-cloud-php | DialogflowCx/src/V3/WebhookRequest.php | https://github.com/googleapis/google-cloud-php/blob/master/DialogflowCx/src/V3/WebhookRequest.php | Apache-2.0 |
public function setTriggerEvent($var)
{
GPBUtil::checkString($var, True);
$this->writeOneof(14, $var);
return $this;
} | If an [event][google.cloud.dialogflow.cx.v3.EventInput] was provided as
input, this field will contain the name of the event.
Generated from protobuf field <code>string trigger_event = 14;</code>
@param string $var
@return $this | setTriggerEvent | php | googleapis/google-cloud-php | DialogflowCx/src/V3/WebhookRequest.php | https://github.com/googleapis/google-cloud-php/blob/master/DialogflowCx/src/V3/WebhookRequest.php | Apache-2.0 |
public function getDtmfDigits()
{
return $this->readOneof(17);
} | If [DTMF][google.cloud.dialogflow.cx.v3.DtmfInput] was provided as input,
this field will contain the DTMF digits.
Generated from protobuf field <code>string dtmf_digits = 17;</code>
@return string | getDtmfDigits | php | googleapis/google-cloud-php | DialogflowCx/src/V3/WebhookRequest.php | https://github.com/googleapis/google-cloud-php/blob/master/DialogflowCx/src/V3/WebhookRequest.php | Apache-2.0 |
public function setDtmfDigits($var)
{
GPBUtil::checkString($var, True);
$this->writeOneof(17, $var);
return $this;
} | If [DTMF][google.cloud.dialogflow.cx.v3.DtmfInput] was provided as input,
this field will contain the DTMF digits.
Generated from protobuf field <code>string dtmf_digits = 17;</code>
@param string $var
@return $this | setDtmfDigits | php | googleapis/google-cloud-php | DialogflowCx/src/V3/WebhookRequest.php | https://github.com/googleapis/google-cloud-php/blob/master/DialogflowCx/src/V3/WebhookRequest.php | Apache-2.0 |
public function getLanguageCode()
{
return $this->language_code;
} | The language code specified in the [original
request][QueryInput.language_code].
Generated from protobuf field <code>string language_code = 15;</code>
@return string | getLanguageCode | php | googleapis/google-cloud-php | DialogflowCx/src/V3/WebhookRequest.php | https://github.com/googleapis/google-cloud-php/blob/master/DialogflowCx/src/V3/WebhookRequest.php | Apache-2.0 |
public function setLanguageCode($var)
{
GPBUtil::checkString($var, True);
$this->language_code = $var;
return $this;
} | The language code specified in the [original
request][QueryInput.language_code].
Generated from protobuf field <code>string language_code = 15;</code>
@param string $var
@return $this | setLanguageCode | php | googleapis/google-cloud-php | DialogflowCx/src/V3/WebhookRequest.php | https://github.com/googleapis/google-cloud-php/blob/master/DialogflowCx/src/V3/WebhookRequest.php | Apache-2.0 |
public function getFulfillmentInfo()
{
return $this->fulfillment_info;
} | Always present. Information about the fulfillment that triggered this
webhook call.
Generated from protobuf field <code>.google.cloud.dialogflow.cx.v3.WebhookRequest.FulfillmentInfo fulfillment_info = 6;</code>
@return \Google\Cloud\Dialogflow\Cx\V3\WebhookRequest\FulfillmentInfo|null | getFulfillmentInfo | php | googleapis/google-cloud-php | DialogflowCx/src/V3/WebhookRequest.php | https://github.com/googleapis/google-cloud-php/blob/master/DialogflowCx/src/V3/WebhookRequest.php | Apache-2.0 |
public function setFulfillmentInfo($var)
{
GPBUtil::checkMessage($var, \Google\Cloud\Dialogflow\Cx\V3\WebhookRequest\FulfillmentInfo::class);
$this->fulfillment_info = $var;
return $this;
} | Always present. Information about the fulfillment that triggered this
webhook call.
Generated from protobuf field <code>.google.cloud.dialogflow.cx.v3.WebhookRequest.FulfillmentInfo fulfillment_info = 6;</code>
@param \Google\Cloud\Dialogflow\Cx\V3\WebhookRequest\FulfillmentInfo $var
@return $this | setFulfillmentInfo | php | googleapis/google-cloud-php | DialogflowCx/src/V3/WebhookRequest.php | https://github.com/googleapis/google-cloud-php/blob/master/DialogflowCx/src/V3/WebhookRequest.php | Apache-2.0 |
public function getIntentInfo()
{
return $this->intent_info;
} | Information about the last matched intent.
Generated from protobuf field <code>.google.cloud.dialogflow.cx.v3.WebhookRequest.IntentInfo intent_info = 3;</code>
@return \Google\Cloud\Dialogflow\Cx\V3\WebhookRequest\IntentInfo|null | getIntentInfo | php | googleapis/google-cloud-php | DialogflowCx/src/V3/WebhookRequest.php | https://github.com/googleapis/google-cloud-php/blob/master/DialogflowCx/src/V3/WebhookRequest.php | Apache-2.0 |
public function setIntentInfo($var)
{
GPBUtil::checkMessage($var, \Google\Cloud\Dialogflow\Cx\V3\WebhookRequest\IntentInfo::class);
$this->intent_info = $var;
return $this;
} | Information about the last matched intent.
Generated from protobuf field <code>.google.cloud.dialogflow.cx.v3.WebhookRequest.IntentInfo intent_info = 3;</code>
@param \Google\Cloud\Dialogflow\Cx\V3\WebhookRequest\IntentInfo $var
@return $this | setIntentInfo | php | googleapis/google-cloud-php | DialogflowCx/src/V3/WebhookRequest.php | https://github.com/googleapis/google-cloud-php/blob/master/DialogflowCx/src/V3/WebhookRequest.php | Apache-2.0 |
public function getPageInfo()
{
return $this->page_info;
} | Information about page status.
Generated from protobuf field <code>.google.cloud.dialogflow.cx.v3.PageInfo page_info = 4;</code>
@return \Google\Cloud\Dialogflow\Cx\V3\PageInfo|null | getPageInfo | php | googleapis/google-cloud-php | DialogflowCx/src/V3/WebhookRequest.php | https://github.com/googleapis/google-cloud-php/blob/master/DialogflowCx/src/V3/WebhookRequest.php | Apache-2.0 |
public function setPageInfo($var)
{
GPBUtil::checkMessage($var, \Google\Cloud\Dialogflow\Cx\V3\PageInfo::class);
$this->page_info = $var;
return $this;
} | Information about page status.
Generated from protobuf field <code>.google.cloud.dialogflow.cx.v3.PageInfo page_info = 4;</code>
@param \Google\Cloud\Dialogflow\Cx\V3\PageInfo $var
@return $this | setPageInfo | php | googleapis/google-cloud-php | DialogflowCx/src/V3/WebhookRequest.php | https://github.com/googleapis/google-cloud-php/blob/master/DialogflowCx/src/V3/WebhookRequest.php | Apache-2.0 |
public function getSessionInfo()
{
return $this->session_info;
} | Information about session status.
Generated from protobuf field <code>.google.cloud.dialogflow.cx.v3.SessionInfo session_info = 5;</code>
@return \Google\Cloud\Dialogflow\Cx\V3\SessionInfo|null | getSessionInfo | php | googleapis/google-cloud-php | DialogflowCx/src/V3/WebhookRequest.php | https://github.com/googleapis/google-cloud-php/blob/master/DialogflowCx/src/V3/WebhookRequest.php | Apache-2.0 |
public function setSessionInfo($var)
{
GPBUtil::checkMessage($var, \Google\Cloud\Dialogflow\Cx\V3\SessionInfo::class);
$this->session_info = $var;
return $this;
} | Information about session status.
Generated from protobuf field <code>.google.cloud.dialogflow.cx.v3.SessionInfo session_info = 5;</code>
@param \Google\Cloud\Dialogflow\Cx\V3\SessionInfo $var
@return $this | setSessionInfo | php | googleapis/google-cloud-php | DialogflowCx/src/V3/WebhookRequest.php | https://github.com/googleapis/google-cloud-php/blob/master/DialogflowCx/src/V3/WebhookRequest.php | Apache-2.0 |
public function getPayload()
{
return $this->payload;
} | Custom data set in
[QueryParameters.payload][google.cloud.dialogflow.cx.v3.QueryParameters.payload].
Generated from protobuf field <code>.google.protobuf.Struct payload = 8;</code>
@return \Google\Protobuf\Struct|null | getPayload | php | googleapis/google-cloud-php | DialogflowCx/src/V3/WebhookRequest.php | https://github.com/googleapis/google-cloud-php/blob/master/DialogflowCx/src/V3/WebhookRequest.php | Apache-2.0 |
public function setPayload($var)
{
GPBUtil::checkMessage($var, \Google\Protobuf\Struct::class);
$this->payload = $var;
return $this;
} | Custom data set in
[QueryParameters.payload][google.cloud.dialogflow.cx.v3.QueryParameters.payload].
Generated from protobuf field <code>.google.protobuf.Struct payload = 8;</code>
@param \Google\Protobuf\Struct $var
@return $this | setPayload | php | googleapis/google-cloud-php | DialogflowCx/src/V3/WebhookRequest.php | https://github.com/googleapis/google-cloud-php/blob/master/DialogflowCx/src/V3/WebhookRequest.php | Apache-2.0 |
public function getSentimentAnalysisResult()
{
return $this->sentiment_analysis_result;
} | The sentiment analysis result of the current user request. The field is
filled when sentiment analysis is configured to be enabled for the request.
Generated from protobuf field <code>.google.cloud.dialogflow.cx.v3.WebhookRequest.SentimentAnalysisResult sentiment_analysis_result = 9;</code>
@return \Google\Cloud\Dialogflow\Cx\V3\WebhookRequest\SentimentAnalysisResult|null | getSentimentAnalysisResult | php | googleapis/google-cloud-php | DialogflowCx/src/V3/WebhookRequest.php | https://github.com/googleapis/google-cloud-php/blob/master/DialogflowCx/src/V3/WebhookRequest.php | Apache-2.0 |
public function setSentimentAnalysisResult($var)
{
GPBUtil::checkMessage($var, \Google\Cloud\Dialogflow\Cx\V3\WebhookRequest\SentimentAnalysisResult::class);
$this->sentiment_analysis_result = $var;
return $this;
} | The sentiment analysis result of the current user request. The field is
filled when sentiment analysis is configured to be enabled for the request.
Generated from protobuf field <code>.google.cloud.dialogflow.cx.v3.WebhookRequest.SentimentAnalysisResult sentiment_analysis_result = 9;</code>
@param \Google\Cloud\Dialogflow\Cx\V3\WebhookRequest\SentimentAnalysisResult $var
@return $this | setSentimentAnalysisResult | php | googleapis/google-cloud-php | DialogflowCx/src/V3/WebhookRequest.php | https://github.com/googleapis/google-cloud-php/blob/master/DialogflowCx/src/V3/WebhookRequest.php | Apache-2.0 |
public function getLanguageInfo()
{
return $this->language_info;
} | Information about the language of the request.
Generated from protobuf field <code>.google.cloud.dialogflow.cx.v3.LanguageInfo language_info = 18;</code>
@return \Google\Cloud\Dialogflow\Cx\V3\LanguageInfo|null | getLanguageInfo | php | googleapis/google-cloud-php | DialogflowCx/src/V3/WebhookRequest.php | https://github.com/googleapis/google-cloud-php/blob/master/DialogflowCx/src/V3/WebhookRequest.php | Apache-2.0 |
public function setLanguageInfo($var)
{
GPBUtil::checkMessage($var, \Google\Cloud\Dialogflow\Cx\V3\LanguageInfo::class);
$this->language_info = $var;
return $this;
} | Information about the language of the request.
Generated from protobuf field <code>.google.cloud.dialogflow.cx.v3.LanguageInfo language_info = 18;</code>
@param \Google\Cloud\Dialogflow\Cx\V3\LanguageInfo $var
@return $this | setLanguageInfo | php | googleapis/google-cloud-php | DialogflowCx/src/V3/WebhookRequest.php | https://github.com/googleapis/google-cloud-php/blob/master/DialogflowCx/src/V3/WebhookRequest.php | Apache-2.0 |
public function getUsedWidgets()
{
return $this->used_widgets;
} | The list of widgets used in an add-on.
Generated from protobuf field <code>repeated .google.apps.script.type.AddOnWidgetSet.WidgetType used_widgets = 1;</code>
@return \Google\Protobuf\Internal\RepeatedField | getUsedWidgets | php | googleapis/google-cloud-php | GSuiteAddOns/external/protos/AddOnWidgetSet.php | https://github.com/googleapis/google-cloud-php/blob/master/GSuiteAddOns/external/protos/AddOnWidgetSet.php | Apache-2.0 |
public function setUsedWidgets($var)
{
$arr = GPBUtil::checkRepeatedField($var, \Google\Protobuf\Internal\GPBType::ENUM, \Google\Apps\Script\Type\AddOnWidgetSet\WidgetType::class);
$this->used_widgets = $arr;
return $this;
} | The list of widgets used in an add-on.
Generated from protobuf field <code>repeated .google.apps.script.type.AddOnWidgetSet.WidgetType used_widgets = 1;</code>
@param array<int>|\Google\Protobuf\Internal\RepeatedField $var
@return $this | setUsedWidgets | php | googleapis/google-cloud-php | GSuiteAddOns/external/protos/AddOnWidgetSet.php | https://github.com/googleapis/google-cloud-php/blob/master/GSuiteAddOns/external/protos/AddOnWidgetSet.php | Apache-2.0 |
public function getUseReference()
{
return $this->use_reference;
} | Optional. Whether to use instance.reference to compute question answering
relevance.
Generated from protobuf field <code>bool use_reference = 1 [(.google.api.field_behavior) = OPTIONAL];</code>
@return bool | getUseReference | php | googleapis/google-cloud-php | AiPlatform/src/V1/QuestionAnsweringRelevanceSpec.php | https://github.com/googleapis/google-cloud-php/blob/master/AiPlatform/src/V1/QuestionAnsweringRelevanceSpec.php | Apache-2.0 |
public function setUseReference($var)
{
GPBUtil::checkBool($var);
$this->use_reference = $var;
return $this;
} | Optional. Whether to use instance.reference to compute question answering
relevance.
Generated from protobuf field <code>bool use_reference = 1 [(.google.api.field_behavior) = OPTIONAL];</code>
@param bool $var
@return $this | setUseReference | php | googleapis/google-cloud-php | AiPlatform/src/V1/QuestionAnsweringRelevanceSpec.php | https://github.com/googleapis/google-cloud-php/blob/master/AiPlatform/src/V1/QuestionAnsweringRelevanceSpec.php | Apache-2.0 |
public function getVersion()
{
return $this->version;
} | Optional. Which version to use for evaluation.
Generated from protobuf field <code>int32 version = 2 [(.google.api.field_behavior) = OPTIONAL];</code>
@return int | getVersion | php | googleapis/google-cloud-php | AiPlatform/src/V1/QuestionAnsweringRelevanceSpec.php | https://github.com/googleapis/google-cloud-php/blob/master/AiPlatform/src/V1/QuestionAnsweringRelevanceSpec.php | Apache-2.0 |
public function setVersion($var)
{
GPBUtil::checkInt32($var);
$this->version = $var;
return $this;
} | Optional. Which version to use for evaluation.
Generated from protobuf field <code>int32 version = 2 [(.google.api.field_behavior) = OPTIONAL];</code>
@param int $var
@return $this | setVersion | php | googleapis/google-cloud-php | AiPlatform/src/V1/QuestionAnsweringRelevanceSpec.php | https://github.com/googleapis/google-cloud-php/blob/master/AiPlatform/src/V1/QuestionAnsweringRelevanceSpec.php | Apache-2.0 |
public function getResource()
{
return $this->resource;
} | Preview of given router.
Generated from protobuf field <code>optional .google.cloud.compute.v1.Router resource = 195806222;</code>
@return \Google\Cloud\Compute\V1\Router|null | getResource | php | googleapis/google-cloud-php | Compute/src/V1/RoutersPreviewResponse.php | https://github.com/googleapis/google-cloud-php/blob/master/Compute/src/V1/RoutersPreviewResponse.php | Apache-2.0 |
public function setResource($var)
{
GPBUtil::checkMessage($var, \Google\Cloud\Compute\V1\Router::class);
$this->resource = $var;
return $this;
} | Preview of given router.
Generated from protobuf field <code>optional .google.cloud.compute.v1.Router resource = 195806222;</code>
@param \Google\Cloud\Compute\V1\Router $var
@return $this | setResource | php | googleapis/google-cloud-php | Compute/src/V1/RoutersPreviewResponse.php | https://github.com/googleapis/google-cloud-php/blob/master/Compute/src/V1/RoutersPreviewResponse.php | Apache-2.0 |
public function getResourceValueConfigs()
{
return $this->resource_value_configs;
} | The resource value configs created
Generated from protobuf field <code>repeated .google.cloud.securitycenter.v1.ResourceValueConfig resource_value_configs = 1;</code>
@return \Google\Protobuf\Internal\RepeatedField | getResourceValueConfigs | php | googleapis/google-cloud-php | SecurityCenter/src/V1/BatchCreateResourceValueConfigsResponse.php | https://github.com/googleapis/google-cloud-php/blob/master/SecurityCenter/src/V1/BatchCreateResourceValueConfigsResponse.php | Apache-2.0 |
public function setResourceValueConfigs($var)
{
$arr = GPBUtil::checkRepeatedField($var, \Google\Protobuf\Internal\GPBType::MESSAGE, \Google\Cloud\SecurityCenter\V1\ResourceValueConfig::class);
$this->resource_value_configs = $arr;
return $this;
} | The resource value configs created
Generated from protobuf field <code>repeated .google.cloud.securitycenter.v1.ResourceValueConfig resource_value_configs = 1;</code>
@param array<\Google\Cloud\SecurityCenter\V1\ResourceValueConfig>|\Google\Protobuf\Internal\RepeatedField $var
@return $this | setResourceValueConfigs | php | googleapis/google-cloud-php | SecurityCenter/src/V1/BatchCreateResourceValueConfigsResponse.php | https://github.com/googleapis/google-cloud-php/blob/master/SecurityCenter/src/V1/BatchCreateResourceValueConfigsResponse.php | Apache-2.0 |
public function getName()
{
return $this->name;
} | Required. Name of the resource.
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 | RapidMigrationAssessment/src/V1/ResumeCollectorRequest.php | https://github.com/googleapis/google-cloud-php/blob/master/RapidMigrationAssessment/src/V1/ResumeCollectorRequest.php | Apache-2.0 |
public function setName($var)
{
GPBUtil::checkString($var, True);
$this->name = $var;
return $this;
} | Required. Name of the resource.
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 | RapidMigrationAssessment/src/V1/ResumeCollectorRequest.php | https://github.com/googleapis/google-cloud-php/blob/master/RapidMigrationAssessment/src/V1/ResumeCollectorRequest.php | Apache-2.0 |
public function getRequestId()
{
return $this->request_id;
} | Optional. An optional request ID to identify requests. Specify a unique
request ID so that if you must retry your request, the server will know to
ignore the request if it has already been completed. The server will
guarantee that for at least 60 minutes after the first request.
For example, consider a situation where you make an initial request and
the request times out. If you make the request again with the same request
ID, the server can check if original operation with the same request ID
was received, and if so, will ignore the second request. This prevents
clients from accidentally creating duplicate commitments.
The request ID must be a valid UUID with the exception that zero UUID is
not supported (00000000-0000-0000-0000-000000000000).
Generated from protobuf field <code>string request_id = 2 [(.google.api.field_behavior) = OPTIONAL];</code>
@return string | getRequestId | php | googleapis/google-cloud-php | RapidMigrationAssessment/src/V1/ResumeCollectorRequest.php | https://github.com/googleapis/google-cloud-php/blob/master/RapidMigrationAssessment/src/V1/ResumeCollectorRequest.php | Apache-2.0 |
public function setRequestId($var)
{
GPBUtil::checkString($var, True);
$this->request_id = $var;
return $this;
} | Optional. An optional request ID to identify requests. Specify a unique
request ID so that if you must retry your request, the server will know to
ignore the request if it has already been completed. The server will
guarantee that for at least 60 minutes after the first request.
For example, consider a situation where you make an initial request and
the request times out. If you make the request again with the same request
ID, the server can check if original operation with the same request ID
was received, and if so, will ignore the second request. This prevents
clients from accidentally creating duplicate commitments.
The request ID must be a valid UUID with the exception that zero UUID is
not supported (00000000-0000-0000-0000-000000000000).
Generated from protobuf field <code>string request_id = 2 [(.google.api.field_behavior) = OPTIONAL];</code>
@param string $var
@return $this | setRequestId | php | googleapis/google-cloud-php | RapidMigrationAssessment/src/V1/ResumeCollectorRequest.php | https://github.com/googleapis/google-cloud-php/blob/master/RapidMigrationAssessment/src/V1/ResumeCollectorRequest.php | Apache-2.0 |
public function getMode()
{
return $this->mode;
} | Mode of the DynamicFacet feature.
Defaults to
[Mode.DISABLED][google.cloud.retail.v2.SearchRequest.DynamicFacetSpec.Mode.DISABLED]
if it's unset.
Generated from protobuf field <code>.google.cloud.retail.v2.SearchRequest.DynamicFacetSpec.Mode mode = 1;</code>
@return int | getMode | php | googleapis/google-cloud-php | Retail/src/V2/SearchRequest/DynamicFacetSpec.php | https://github.com/googleapis/google-cloud-php/blob/master/Retail/src/V2/SearchRequest/DynamicFacetSpec.php | Apache-2.0 |
public function setMode($var)
{
GPBUtil::checkEnum($var, \Google\Cloud\Retail\V2\SearchRequest\DynamicFacetSpec\Mode::class);
$this->mode = $var;
return $this;
} | Mode of the DynamicFacet feature.
Defaults to
[Mode.DISABLED][google.cloud.retail.v2.SearchRequest.DynamicFacetSpec.Mode.DISABLED]
if it's unset.
Generated from protobuf field <code>.google.cloud.retail.v2.SearchRequest.DynamicFacetSpec.Mode mode = 1;</code>
@param int $var
@return $this | setMode | php | googleapis/google-cloud-php | Retail/src/V2/SearchRequest/DynamicFacetSpec.php | https://github.com/googleapis/google-cloud-php/blob/master/Retail/src/V2/SearchRequest/DynamicFacetSpec.php | Apache-2.0 |
public function getPercentComplete()
{
return $this->percent_complete;
} | An estimate of how close this report is to being completed. Will always be
100 for failed and completed reports.
Generated from protobuf field <code>int32 percent_complete = 2;</code>
@return int | getPercentComplete | php | googleapis/google-cloud-php | AdsAdManager/src/V1/RunReportMetadata.php | https://github.com/googleapis/google-cloud-php/blob/master/AdsAdManager/src/V1/RunReportMetadata.php | Apache-2.0 |
public function setPercentComplete($var)
{
GPBUtil::checkInt32($var);
$this->percent_complete = $var;
return $this;
} | An estimate of how close this report is to being completed. Will always be
100 for failed and completed reports.
Generated from protobuf field <code>int32 percent_complete = 2;</code>
@param int $var
@return $this | setPercentComplete | php | googleapis/google-cloud-php | AdsAdManager/src/V1/RunReportMetadata.php | https://github.com/googleapis/google-cloud-php/blob/master/AdsAdManager/src/V1/RunReportMetadata.php | Apache-2.0 |
public function getReport()
{
return $this->report;
} | The result's parent report.
Generated from protobuf field <code>string report = 4 [(.google.api.resource_reference) = {</code>
@return string | getReport | php | googleapis/google-cloud-php | AdsAdManager/src/V1/RunReportMetadata.php | https://github.com/googleapis/google-cloud-php/blob/master/AdsAdManager/src/V1/RunReportMetadata.php | Apache-2.0 |
public function setReport($var)
{
GPBUtil::checkString($var, True);
$this->report = $var;
return $this;
} | The result's parent report.
Generated from protobuf field <code>string report = 4 [(.google.api.resource_reference) = {</code>
@param string $var
@return $this | setReport | php | googleapis/google-cloud-php | AdsAdManager/src/V1/RunReportMetadata.php | https://github.com/googleapis/google-cloud-php/blob/master/AdsAdManager/src/V1/RunReportMetadata.php | Apache-2.0 |
public function getParent()
{
return $this->parent;
} | Required. The parent value for ListAutonomousDatabaseBackups in the
following format: projects/{project}/locations/{location}.
Generated from protobuf field <code>string parent = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = {</code>
@return string | getParent | php | googleapis/google-cloud-php | OracleDatabase/src/V1/ListAutonomousDatabaseBackupsRequest.php | https://github.com/googleapis/google-cloud-php/blob/master/OracleDatabase/src/V1/ListAutonomousDatabaseBackupsRequest.php | Apache-2.0 |
public function setParent($var)
{
GPBUtil::checkString($var, True);
$this->parent = $var;
return $this;
} | Required. The parent value for ListAutonomousDatabaseBackups in the
following format: projects/{project}/locations/{location}.
Generated from protobuf field <code>string parent = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = {</code>
@param string $var
@return $this | setParent | php | googleapis/google-cloud-php | OracleDatabase/src/V1/ListAutonomousDatabaseBackupsRequest.php | https://github.com/googleapis/google-cloud-php/blob/master/OracleDatabase/src/V1/ListAutonomousDatabaseBackupsRequest.php | Apache-2.0 |
public function getFilter()
{
return $this->filter;
} | Optional. An expression for filtering the results of the request. Only the
**autonomous_database_id** field is supported in the following format:
`autonomous_database_id="{autonomous_database_id}"`. The accepted values
must be a valid Autonomous Database ID, limited to the naming
restrictions of the ID: ^[a-z]([a-z0-9-]{0,61}[a-z0-9])?$).
The ID must start with a letter, end with a letter or a number, and be
a maximum of 63 characters.
Generated from protobuf field <code>string filter = 5 [(.google.api.field_behavior) = OPTIONAL];</code>
@return string | getFilter | php | googleapis/google-cloud-php | OracleDatabase/src/V1/ListAutonomousDatabaseBackupsRequest.php | https://github.com/googleapis/google-cloud-php/blob/master/OracleDatabase/src/V1/ListAutonomousDatabaseBackupsRequest.php | Apache-2.0 |
public function setFilter($var)
{
GPBUtil::checkString($var, True);
$this->filter = $var;
return $this;
} | Optional. An expression for filtering the results of the request. Only the
**autonomous_database_id** field is supported in the following format:
`autonomous_database_id="{autonomous_database_id}"`. The accepted values
must be a valid Autonomous Database ID, limited to the naming
restrictions of the ID: ^[a-z]([a-z0-9-]{0,61}[a-z0-9])?$).
The ID must start with a letter, end with a letter or a number, and be
a maximum of 63 characters.
Generated from protobuf field <code>string filter = 5 [(.google.api.field_behavior) = OPTIONAL];</code>
@param string $var
@return $this | setFilter | php | googleapis/google-cloud-php | OracleDatabase/src/V1/ListAutonomousDatabaseBackupsRequest.php | https://github.com/googleapis/google-cloud-php/blob/master/OracleDatabase/src/V1/ListAutonomousDatabaseBackupsRequest.php | Apache-2.0 |
public function getPageSize()
{
return $this->page_size;
} | Optional. The maximum number of items to return.
If unspecified, at most 50 Autonomous DB Backups will be returned.
The maximum value is 1000; values above 1000 will be coerced to 1000.
Generated from protobuf field <code>int32 page_size = 3 [(.google.api.field_behavior) = OPTIONAL];</code>
@return int | getPageSize | php | googleapis/google-cloud-php | OracleDatabase/src/V1/ListAutonomousDatabaseBackupsRequest.php | https://github.com/googleapis/google-cloud-php/blob/master/OracleDatabase/src/V1/ListAutonomousDatabaseBackupsRequest.php | Apache-2.0 |
public function setPageSize($var)
{
GPBUtil::checkInt32($var);
$this->page_size = $var;
return $this;
} | Optional. The maximum number of items to return.
If unspecified, at most 50 Autonomous DB Backups will be returned.
The maximum value is 1000; values above 1000 will be coerced to 1000.
Generated from protobuf field <code>int32 page_size = 3 [(.google.api.field_behavior) = OPTIONAL];</code>
@param int $var
@return $this | setPageSize | php | googleapis/google-cloud-php | OracleDatabase/src/V1/ListAutonomousDatabaseBackupsRequest.php | https://github.com/googleapis/google-cloud-php/blob/master/OracleDatabase/src/V1/ListAutonomousDatabaseBackupsRequest.php | Apache-2.0 |
public function getPageToken()
{
return $this->page_token;
} | Optional. A token identifying a page of results the server should return.
Generated from protobuf field <code>string page_token = 4 [(.google.api.field_behavior) = OPTIONAL];</code>
@return string | getPageToken | php | googleapis/google-cloud-php | OracleDatabase/src/V1/ListAutonomousDatabaseBackupsRequest.php | https://github.com/googleapis/google-cloud-php/blob/master/OracleDatabase/src/V1/ListAutonomousDatabaseBackupsRequest.php | Apache-2.0 |
public function setPageToken($var)
{
GPBUtil::checkString($var, True);
$this->page_token = $var;
return $this;
} | Optional. A token identifying a page of results the server should return.
Generated from protobuf field <code>string page_token = 4 [(.google.api.field_behavior) = OPTIONAL];</code>
@param string $var
@return $this | setPageToken | php | googleapis/google-cloud-php | OracleDatabase/src/V1/ListAutonomousDatabaseBackupsRequest.php | https://github.com/googleapis/google-cloud-php/blob/master/OracleDatabase/src/V1/ListAutonomousDatabaseBackupsRequest.php | Apache-2.0 |
public function getCertificateAuthority()
{
return $this->certificate_authority;
} | Required.
[CertificateAuthority][google.cloud.security.privateca.v1.CertificateAuthority]
with updated values.
Generated from protobuf field <code>.google.cloud.security.privateca.v1.CertificateAuthority certificate_authority = 1 [(.google.api.field_behavior) = REQUIRED];</code>
@return \Google\Cloud\Security\PrivateCA\V1\CertificateAuthority|null | getCertificateAuthority | php | googleapis/google-cloud-php | SecurityPrivateCa/src/V1/UpdateCertificateAuthorityRequest.php | https://github.com/googleapis/google-cloud-php/blob/master/SecurityPrivateCa/src/V1/UpdateCertificateAuthorityRequest.php | Apache-2.0 |
public function setCertificateAuthority($var)
{
GPBUtil::checkMessage($var, \Google\Cloud\Security\PrivateCA\V1\CertificateAuthority::class);
$this->certificate_authority = $var;
return $this;
} | Required.
[CertificateAuthority][google.cloud.security.privateca.v1.CertificateAuthority]
with updated values.
Generated from protobuf field <code>.google.cloud.security.privateca.v1.CertificateAuthority certificate_authority = 1 [(.google.api.field_behavior) = REQUIRED];</code>
@param \Google\Cloud\Security\PrivateCA\V1\CertificateAuthority $var
@return $this | setCertificateAuthority | php | googleapis/google-cloud-php | SecurityPrivateCa/src/V1/UpdateCertificateAuthorityRequest.php | https://github.com/googleapis/google-cloud-php/blob/master/SecurityPrivateCa/src/V1/UpdateCertificateAuthorityRequest.php | Apache-2.0 |
public function getUpdateMask()
{
return $this->update_mask;
} | Required. A list of fields to be updated in this request.
Generated from protobuf field <code>.google.protobuf.FieldMask update_mask = 2 [(.google.api.field_behavior) = REQUIRED];</code>
@return \Google\Protobuf\FieldMask|null | getUpdateMask | php | googleapis/google-cloud-php | SecurityPrivateCa/src/V1/UpdateCertificateAuthorityRequest.php | https://github.com/googleapis/google-cloud-php/blob/master/SecurityPrivateCa/src/V1/UpdateCertificateAuthorityRequest.php | Apache-2.0 |
public function setUpdateMask($var)
{
GPBUtil::checkMessage($var, \Google\Protobuf\FieldMask::class);
$this->update_mask = $var;
return $this;
} | Required. A list of fields to be updated in this request.
Generated from protobuf field <code>.google.protobuf.FieldMask update_mask = 2 [(.google.api.field_behavior) = REQUIRED];</code>
@param \Google\Protobuf\FieldMask $var
@return $this | setUpdateMask | php | googleapis/google-cloud-php | SecurityPrivateCa/src/V1/UpdateCertificateAuthorityRequest.php | https://github.com/googleapis/google-cloud-php/blob/master/SecurityPrivateCa/src/V1/UpdateCertificateAuthorityRequest.php | Apache-2.0 |
public function getRequestId()
{
return $this->request_id;
} | Optional. An ID to identify requests. Specify a unique request ID so that
if you must retry your request, the server will know to ignore the request
if it has already been completed. The server will guarantee that for at
least 60 minutes since the first request.
For example, consider a situation where you make an initial request and
the request times out. If you make the request again with the same request
ID, the server can check if original operation with the same request ID
was received, and if so, will ignore the second request. This prevents
clients from accidentally creating duplicate commitments.
The request ID must be a valid UUID with the exception that zero UUID is
not supported (00000000-0000-0000-0000-000000000000).
Generated from protobuf field <code>string request_id = 3 [(.google.api.field_behavior) = OPTIONAL];</code>
@return string | getRequestId | php | googleapis/google-cloud-php | SecurityPrivateCa/src/V1/UpdateCertificateAuthorityRequest.php | https://github.com/googleapis/google-cloud-php/blob/master/SecurityPrivateCa/src/V1/UpdateCertificateAuthorityRequest.php | Apache-2.0 |
public function setRequestId($var)
{
GPBUtil::checkString($var, True);
$this->request_id = $var;
return $this;
} | Optional. An ID to identify requests. Specify a unique request ID so that
if you must retry your request, the server will know to ignore the request
if it has already been completed. The server will guarantee that for at
least 60 minutes since the first request.
For example, consider a situation where you make an initial request and
the request times out. If you make the request again with the same request
ID, the server can check if original operation with the same request ID
was received, and if so, will ignore the second request. This prevents
clients from accidentally creating duplicate commitments.
The request ID must be a valid UUID with the exception that zero UUID is
not supported (00000000-0000-0000-0000-000000000000).
Generated from protobuf field <code>string request_id = 3 [(.google.api.field_behavior) = OPTIONAL];</code>
@param string $var
@return $this | setRequestId | php | googleapis/google-cloud-php | SecurityPrivateCa/src/V1/UpdateCertificateAuthorityRequest.php | https://github.com/googleapis/google-cloud-php/blob/master/SecurityPrivateCa/src/V1/UpdateCertificateAuthorityRequest.php | Apache-2.0 |
public function getAudioUri()
{
return $this->audio_uri;
} | Cloud Storage URI that points to a file that contains the conversation
audio.
Generated from protobuf field <code>string audio_uri = 3;</code>
@return string | getAudioUri | php | googleapis/google-cloud-php | ContactCenterInsights/src/V1/DialogflowSource.php | https://github.com/googleapis/google-cloud-php/blob/master/ContactCenterInsights/src/V1/DialogflowSource.php | Apache-2.0 |
public function setAudioUri($var)
{
GPBUtil::checkString($var, True);
$this->audio_uri = $var;
return $this;
} | Cloud Storage URI that points to a file that contains the conversation
audio.
Generated from protobuf field <code>string audio_uri = 3;</code>
@param string $var
@return $this | setAudioUri | php | googleapis/google-cloud-php | ContactCenterInsights/src/V1/DialogflowSource.php | https://github.com/googleapis/google-cloud-php/blob/master/ContactCenterInsights/src/V1/DialogflowSource.php | Apache-2.0 |
public function getUpdateMask()
{
return $this->update_mask;
} | Required. Mask of fields to update. At least one path must be supplied in
this field. The elements of the repeated paths field may only include these
fields from [BeyondCorp.AppConnection]:
* `labels`
* `display_name`
* `application_endpoint`
* `connectors`
Generated from protobuf field <code>.google.protobuf.FieldMask update_mask = 1 [(.google.api.field_behavior) = REQUIRED];</code>
@return \Google\Protobuf\FieldMask|null | getUpdateMask | php | googleapis/google-cloud-php | BeyondCorpAppConnections/src/V1/UpdateAppConnectionRequest.php | https://github.com/googleapis/google-cloud-php/blob/master/BeyondCorpAppConnections/src/V1/UpdateAppConnectionRequest.php | Apache-2.0 |
Subsets and Splits
No community queries yet
The top public SQL queries from the community will appear here once available.