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 setUri($var)
{
GPBUtil::checkString($var, True);
$this->uri = $var;
return $this;
} | The URL including cgi-parameters but excluding the hash fragment with a
length limit of 5,000 characters. This is often more useful than the
referer URL, because many browsers only send the domain for third-party
requests.
Generated from protobuf field <code>optional string uri = 3;</code>
@param string $var
@return $this | setUri | php | googleapis/google-cloud-php | DiscoveryEngine/src/V1/CollectUserEventRequest.php | https://github.com/googleapis/google-cloud-php/blob/master/DiscoveryEngine/src/V1/CollectUserEventRequest.php | Apache-2.0 |
public function getEts()
{
return isset($this->ets) ? $this->ets : 0;
} | The event timestamp in milliseconds. This prevents browser caching of
otherwise identical get requests. The name is abbreviated to reduce the
payload bytes.
Generated from protobuf field <code>optional int64 ets = 4;</code>
@return int|string | getEts | php | googleapis/google-cloud-php | DiscoveryEngine/src/V1/CollectUserEventRequest.php | https://github.com/googleapis/google-cloud-php/blob/master/DiscoveryEngine/src/V1/CollectUserEventRequest.php | Apache-2.0 |
public function setEts($var)
{
GPBUtil::checkInt64($var);
$this->ets = $var;
return $this;
} | The event timestamp in milliseconds. This prevents browser caching of
otherwise identical get requests. The name is abbreviated to reduce the
payload bytes.
Generated from protobuf field <code>optional int64 ets = 4;</code>
@param int|string $var
@return $this | setEts | php | googleapis/google-cloud-php | DiscoveryEngine/src/V1/CollectUserEventRequest.php | https://github.com/googleapis/google-cloud-php/blob/master/DiscoveryEngine/src/V1/CollectUserEventRequest.php | Apache-2.0 |
public function getTransferParameters()
{
return $this->transfer_parameters;
} | Parameters to use when calling the `TransferDomain` method.
Generated from protobuf field <code>.google.cloud.domains.v1.TransferParameters transfer_parameters = 1;</code>
@return \Google\Cloud\Domains\V1\TransferParameters|null | getTransferParameters | php | googleapis/google-cloud-php | Domains/src/V1/RetrieveTransferParametersResponse.php | https://github.com/googleapis/google-cloud-php/blob/master/Domains/src/V1/RetrieveTransferParametersResponse.php | Apache-2.0 |
public function setTransferParameters($var)
{
GPBUtil::checkMessage($var, \Google\Cloud\Domains\V1\TransferParameters::class);
$this->transfer_parameters = $var;
return $this;
} | Parameters to use when calling the `TransferDomain` method.
Generated from protobuf field <code>.google.cloud.domains.v1.TransferParameters transfer_parameters = 1;</code>
@param \Google\Cloud\Domains\V1\TransferParameters $var
@return $this | setTransferParameters | php | googleapis/google-cloud-php | Domains/src/V1/RetrieveTransferParametersResponse.php | https://github.com/googleapis/google-cloud-php/blob/master/Domains/src/V1/RetrieveTransferParametersResponse.php | Apache-2.0 |
public function getBoundingBox()
{
return $this->bounding_box;
} | Output only. The rectangle representing the object location.
Generated from protobuf field <code>.google.cloud.automl.v1.BoundingPoly bounding_box = 1;</code>
@return \Google\Cloud\AutoMl\V1\BoundingPoly|null | getBoundingBox | php | googleapis/google-cloud-php | AutoMl/src/V1/ImageObjectDetectionAnnotation.php | https://github.com/googleapis/google-cloud-php/blob/master/AutoMl/src/V1/ImageObjectDetectionAnnotation.php | Apache-2.0 |
public function setBoundingBox($var)
{
GPBUtil::checkMessage($var, \Google\Cloud\AutoMl\V1\BoundingPoly::class);
$this->bounding_box = $var;
return $this;
} | Output only. The rectangle representing the object location.
Generated from protobuf field <code>.google.cloud.automl.v1.BoundingPoly bounding_box = 1;</code>
@param \Google\Cloud\AutoMl\V1\BoundingPoly $var
@return $this | setBoundingBox | php | googleapis/google-cloud-php | AutoMl/src/V1/ImageObjectDetectionAnnotation.php | https://github.com/googleapis/google-cloud-php/blob/master/AutoMl/src/V1/ImageObjectDetectionAnnotation.php | Apache-2.0 |
public function getScore()
{
return $this->score;
} | Output only. The confidence that this annotation is positive for the parent example,
value in [0, 1], higher means higher positivity confidence.
Generated from protobuf field <code>float score = 2;</code>
@return float | getScore | php | googleapis/google-cloud-php | AutoMl/src/V1/ImageObjectDetectionAnnotation.php | https://github.com/googleapis/google-cloud-php/blob/master/AutoMl/src/V1/ImageObjectDetectionAnnotation.php | Apache-2.0 |
public function setScore($var)
{
GPBUtil::checkFloat($var);
$this->score = $var;
return $this;
} | Output only. The confidence that this annotation is positive for the parent example,
value in [0, 1], higher means higher positivity confidence.
Generated from protobuf field <code>float score = 2;</code>
@param float $var
@return $this | setScore | php | googleapis/google-cloud-php | AutoMl/src/V1/ImageObjectDetectionAnnotation.php | https://github.com/googleapis/google-cloud-php/blob/master/AutoMl/src/V1/ImageObjectDetectionAnnotation.php | Apache-2.0 |
public function getAutoDecodingConfig()
{
return $this->readOneof(7);
} | Automatically detect decoding parameters.
Preferred for supported formats.
Generated from protobuf field <code>.google.cloud.speech.v2.AutoDetectDecodingConfig auto_decoding_config = 7;</code>
@return \Google\Cloud\Speech\V2\AutoDetectDecodingConfig|null | getAutoDecodingConfig | php | googleapis/google-cloud-php | Speech/src/V2/RecognitionConfig.php | https://github.com/googleapis/google-cloud-php/blob/master/Speech/src/V2/RecognitionConfig.php | Apache-2.0 |
public function setAutoDecodingConfig($var)
{
GPBUtil::checkMessage($var, \Google\Cloud\Speech\V2\AutoDetectDecodingConfig::class);
$this->writeOneof(7, $var);
return $this;
} | Automatically detect decoding parameters.
Preferred for supported formats.
Generated from protobuf field <code>.google.cloud.speech.v2.AutoDetectDecodingConfig auto_decoding_config = 7;</code>
@param \Google\Cloud\Speech\V2\AutoDetectDecodingConfig $var
@return $this | setAutoDecodingConfig | php | googleapis/google-cloud-php | Speech/src/V2/RecognitionConfig.php | https://github.com/googleapis/google-cloud-php/blob/master/Speech/src/V2/RecognitionConfig.php | Apache-2.0 |
public function getExplicitDecodingConfig()
{
return $this->readOneof(8);
} | Explicitly specified decoding parameters.
Required if using headerless PCM audio (linear16, mulaw, alaw).
Generated from protobuf field <code>.google.cloud.speech.v2.ExplicitDecodingConfig explicit_decoding_config = 8;</code>
@return \Google\Cloud\Speech\V2\ExplicitDecodingConfig|null | getExplicitDecodingConfig | php | googleapis/google-cloud-php | Speech/src/V2/RecognitionConfig.php | https://github.com/googleapis/google-cloud-php/blob/master/Speech/src/V2/RecognitionConfig.php | Apache-2.0 |
public function setExplicitDecodingConfig($var)
{
GPBUtil::checkMessage($var, \Google\Cloud\Speech\V2\ExplicitDecodingConfig::class);
$this->writeOneof(8, $var);
return $this;
} | Explicitly specified decoding parameters.
Required if using headerless PCM audio (linear16, mulaw, alaw).
Generated from protobuf field <code>.google.cloud.speech.v2.ExplicitDecodingConfig explicit_decoding_config = 8;</code>
@param \Google\Cloud\Speech\V2\ExplicitDecodingConfig $var
@return $this | setExplicitDecodingConfig | php | googleapis/google-cloud-php | Speech/src/V2/RecognitionConfig.php | https://github.com/googleapis/google-cloud-php/blob/master/Speech/src/V2/RecognitionConfig.php | Apache-2.0 |
public function getModel()
{
return $this->model;
} | Optional. 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 = 9 [(.google.api.field_behavior) = OPTIONAL];</code>
@return string | getModel | php | googleapis/google-cloud-php | Speech/src/V2/RecognitionConfig.php | https://github.com/googleapis/google-cloud-php/blob/master/Speech/src/V2/RecognitionConfig.php | Apache-2.0 |
public function setModel($var)
{
GPBUtil::checkString($var, True);
$this->model = $var;
return $this;
} | Optional. 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 = 9 [(.google.api.field_behavior) = OPTIONAL];</code>
@param string $var
@return $this | setModel | php | googleapis/google-cloud-php | Speech/src/V2/RecognitionConfig.php | https://github.com/googleapis/google-cloud-php/blob/master/Speech/src/V2/RecognitionConfig.php | Apache-2.0 |
public function getLanguageCodes()
{
return $this->language_codes;
} | Optional. The language of the supplied audio as a
[BCP-47](https://www.rfc-editor.org/rfc/bcp/bcp47.txt) language tag.
Language tags are normalized to BCP-47 before they are used eg "en-us"
becomes "en-US".
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.
Generated from protobuf field <code>repeated string language_codes = 10 [(.google.api.field_behavior) = OPTIONAL];</code>
@return \Google\Protobuf\Internal\RepeatedField | getLanguageCodes | php | googleapis/google-cloud-php | Speech/src/V2/RecognitionConfig.php | https://github.com/googleapis/google-cloud-php/blob/master/Speech/src/V2/RecognitionConfig.php | Apache-2.0 |
public function setLanguageCodes($var)
{
$arr = GPBUtil::checkRepeatedField($var, \Google\Protobuf\Internal\GPBType::STRING);
$this->language_codes = $arr;
return $this;
} | Optional. The language of the supplied audio as a
[BCP-47](https://www.rfc-editor.org/rfc/bcp/bcp47.txt) language tag.
Language tags are normalized to BCP-47 before they are used eg "en-us"
becomes "en-US".
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.
Generated from protobuf field <code>repeated string language_codes = 10 [(.google.api.field_behavior) = OPTIONAL];</code>
@param array<string>|\Google\Protobuf\Internal\RepeatedField $var
@return $this | setLanguageCodes | php | googleapis/google-cloud-php | Speech/src/V2/RecognitionConfig.php | https://github.com/googleapis/google-cloud-php/blob/master/Speech/src/V2/RecognitionConfig.php | Apache-2.0 |
public function getFeatures()
{
return $this->features;
} | Speech recognition features to enable.
Generated from protobuf field <code>.google.cloud.speech.v2.RecognitionFeatures features = 2;</code>
@return \Google\Cloud\Speech\V2\RecognitionFeatures|null | getFeatures | php | googleapis/google-cloud-php | Speech/src/V2/RecognitionConfig.php | https://github.com/googleapis/google-cloud-php/blob/master/Speech/src/V2/RecognitionConfig.php | Apache-2.0 |
public function setFeatures($var)
{
GPBUtil::checkMessage($var, \Google\Cloud\Speech\V2\RecognitionFeatures::class);
$this->features = $var;
return $this;
} | Speech recognition features to enable.
Generated from protobuf field <code>.google.cloud.speech.v2.RecognitionFeatures features = 2;</code>
@param \Google\Cloud\Speech\V2\RecognitionFeatures $var
@return $this | setFeatures | php | googleapis/google-cloud-php | Speech/src/V2/RecognitionConfig.php | https://github.com/googleapis/google-cloud-php/blob/master/Speech/src/V2/RecognitionConfig.php | Apache-2.0 |
public function getAdaptation()
{
return $this->adaptation;
} | Speech adaptation context that weights recognizer predictions for specific
words and phrases.
Generated from protobuf field <code>.google.cloud.speech.v2.SpeechAdaptation adaptation = 6;</code>
@return \Google\Cloud\Speech\V2\SpeechAdaptation|null | getAdaptation | php | googleapis/google-cloud-php | Speech/src/V2/RecognitionConfig.php | https://github.com/googleapis/google-cloud-php/blob/master/Speech/src/V2/RecognitionConfig.php | Apache-2.0 |
public function setAdaptation($var)
{
GPBUtil::checkMessage($var, \Google\Cloud\Speech\V2\SpeechAdaptation::class);
$this->adaptation = $var;
return $this;
} | Speech adaptation context that weights recognizer predictions for specific
words and phrases.
Generated from protobuf field <code>.google.cloud.speech.v2.SpeechAdaptation adaptation = 6;</code>
@param \Google\Cloud\Speech\V2\SpeechAdaptation $var
@return $this | setAdaptation | php | googleapis/google-cloud-php | Speech/src/V2/RecognitionConfig.php | https://github.com/googleapis/google-cloud-php/blob/master/Speech/src/V2/RecognitionConfig.php | Apache-2.0 |
public function getTranscriptNormalization()
{
return $this->transcript_normalization;
} | Optional. Use transcription normalization to automatically replace parts of
the transcript with phrases of your choosing. For StreamingRecognize, this
normalization only applies to stable partial transcripts (stability > 0.8)
and final transcripts.
Generated from protobuf field <code>.google.cloud.speech.v2.TranscriptNormalization transcript_normalization = 11 [(.google.api.field_behavior) = OPTIONAL];</code>
@return \Google\Cloud\Speech\V2\TranscriptNormalization|null | getTranscriptNormalization | php | googleapis/google-cloud-php | Speech/src/V2/RecognitionConfig.php | https://github.com/googleapis/google-cloud-php/blob/master/Speech/src/V2/RecognitionConfig.php | Apache-2.0 |
public function setTranscriptNormalization($var)
{
GPBUtil::checkMessage($var, \Google\Cloud\Speech\V2\TranscriptNormalization::class);
$this->transcript_normalization = $var;
return $this;
} | Optional. Use transcription normalization to automatically replace parts of
the transcript with phrases of your choosing. For StreamingRecognize, this
normalization only applies to stable partial transcripts (stability > 0.8)
and final transcripts.
Generated from protobuf field <code>.google.cloud.speech.v2.TranscriptNormalization transcript_normalization = 11 [(.google.api.field_behavior) = OPTIONAL];</code>
@param \Google\Cloud\Speech\V2\TranscriptNormalization $var
@return $this | setTranscriptNormalization | php | googleapis/google-cloud-php | Speech/src/V2/RecognitionConfig.php | https://github.com/googleapis/google-cloud-php/blob/master/Speech/src/V2/RecognitionConfig.php | Apache-2.0 |
public function getTranslationConfig()
{
return $this->translation_config;
} | Optional. Optional configuration used to automatically run translation on
the given audio to the desired language for supported models.
Generated from protobuf field <code>.google.cloud.speech.v2.TranslationConfig translation_config = 15 [(.google.api.field_behavior) = OPTIONAL];</code>
@return \Google\Cloud\Speech\V2\TranslationConfig|null | getTranslationConfig | php | googleapis/google-cloud-php | Speech/src/V2/RecognitionConfig.php | https://github.com/googleapis/google-cloud-php/blob/master/Speech/src/V2/RecognitionConfig.php | Apache-2.0 |
public function setTranslationConfig($var)
{
GPBUtil::checkMessage($var, \Google\Cloud\Speech\V2\TranslationConfig::class);
$this->translation_config = $var;
return $this;
} | Optional. Optional configuration used to automatically run translation on
the given audio to the desired language for supported models.
Generated from protobuf field <code>.google.cloud.speech.v2.TranslationConfig translation_config = 15 [(.google.api.field_behavior) = OPTIONAL];</code>
@param \Google\Cloud\Speech\V2\TranslationConfig $var
@return $this | setTranslationConfig | php | googleapis/google-cloud-php | Speech/src/V2/RecognitionConfig.php | https://github.com/googleapis/google-cloud-php/blob/master/Speech/src/V2/RecognitionConfig.php | Apache-2.0 |
public function getService()
{
return $this->service;
} | The name of the service that this resource belongs to, such as
`compute.googleapis.com`. The service name might not match the DNS
hostname that actually serves the request.
For a full list of resource service values, see
https://cloud.google.com/iam/help/conditions/resource-services
Generated from protobuf field <code>string service = 1;</code>
@return string | getService | php | googleapis/google-cloud-php | PolicyTroubleshooterIam/src/V3/ConditionContext/Resource.php | https://github.com/googleapis/google-cloud-php/blob/master/PolicyTroubleshooterIam/src/V3/ConditionContext/Resource.php | Apache-2.0 |
public function setService($var)
{
GPBUtil::checkString($var, True);
$this->service = $var;
return $this;
} | The name of the service that this resource belongs to, such as
`compute.googleapis.com`. The service name might not match the DNS
hostname that actually serves the request.
For a full list of resource service values, see
https://cloud.google.com/iam/help/conditions/resource-services
Generated from protobuf field <code>string service = 1;</code>
@param string $var
@return $this | setService | php | googleapis/google-cloud-php | PolicyTroubleshooterIam/src/V3/ConditionContext/Resource.php | https://github.com/googleapis/google-cloud-php/blob/master/PolicyTroubleshooterIam/src/V3/ConditionContext/Resource.php | Apache-2.0 |
public function getName()
{
return $this->name;
} | The stable identifier (name) of a resource on the `service`. A resource
can be logically identified as `//{resource.service}/{resource.name}`.
Unlike the resource URI, the resource name doesn't contain any protocol
and version information.
For a list of full resource name formats, see
https://cloud.google.com/iam/help/troubleshooter/full-resource-names
Generated from protobuf field <code>string name = 2;</code>
@return string | getName | php | googleapis/google-cloud-php | PolicyTroubleshooterIam/src/V3/ConditionContext/Resource.php | https://github.com/googleapis/google-cloud-php/blob/master/PolicyTroubleshooterIam/src/V3/ConditionContext/Resource.php | Apache-2.0 |
public function setName($var)
{
GPBUtil::checkString($var, True);
$this->name = $var;
return $this;
} | The stable identifier (name) of a resource on the `service`. A resource
can be logically identified as `//{resource.service}/{resource.name}`.
Unlike the resource URI, the resource name doesn't contain any protocol
and version information.
For a list of full resource name formats, see
https://cloud.google.com/iam/help/troubleshooter/full-resource-names
Generated from protobuf field <code>string name = 2;</code>
@param string $var
@return $this | setName | php | googleapis/google-cloud-php | PolicyTroubleshooterIam/src/V3/ConditionContext/Resource.php | https://github.com/googleapis/google-cloud-php/blob/master/PolicyTroubleshooterIam/src/V3/ConditionContext/Resource.php | Apache-2.0 |
public function getType()
{
return $this->type;
} | The type of the resource, in the format `{service}/{kind}`.
For a full list of resource type values, see
https://cloud.google.com/iam/help/conditions/resource-types
Generated from protobuf field <code>string type = 3;</code>
@return string | getType | php | googleapis/google-cloud-php | PolicyTroubleshooterIam/src/V3/ConditionContext/Resource.php | https://github.com/googleapis/google-cloud-php/blob/master/PolicyTroubleshooterIam/src/V3/ConditionContext/Resource.php | Apache-2.0 |
public function setType($var)
{
GPBUtil::checkString($var, True);
$this->type = $var;
return $this;
} | The type of the resource, in the format `{service}/{kind}`.
For a full list of resource type values, see
https://cloud.google.com/iam/help/conditions/resource-types
Generated from protobuf field <code>string type = 3;</code>
@param string $var
@return $this | setType | php | googleapis/google-cloud-php | PolicyTroubleshooterIam/src/V3/ConditionContext/Resource.php | https://github.com/googleapis/google-cloud-php/blob/master/PolicyTroubleshooterIam/src/V3/ConditionContext/Resource.php | Apache-2.0 |
public function getNetworkEdgeSecurityServices()
{
return $this->network_edge_security_services;
} | A list of NetworkEdgeSecurityServices contained in this scope.
Generated from protobuf field <code>repeated .google.cloud.compute.v1.NetworkEdgeSecurityService network_edge_security_services = 35530156;</code>
@return \Google\Protobuf\Internal\RepeatedField | getNetworkEdgeSecurityServices | php | googleapis/google-cloud-php | Compute/src/V1/NetworkEdgeSecurityServicesScopedList.php | https://github.com/googleapis/google-cloud-php/blob/master/Compute/src/V1/NetworkEdgeSecurityServicesScopedList.php | Apache-2.0 |
public function setNetworkEdgeSecurityServices($var)
{
$arr = GPBUtil::checkRepeatedField($var, \Google\Protobuf\Internal\GPBType::MESSAGE, \Google\Cloud\Compute\V1\NetworkEdgeSecurityService::class);
$this->network_edge_security_services = $arr;
return $this;
} | A list of NetworkEdgeSecurityServices contained in this scope.
Generated from protobuf field <code>repeated .google.cloud.compute.v1.NetworkEdgeSecurityService network_edge_security_services = 35530156;</code>
@param array<\Google\Cloud\Compute\V1\NetworkEdgeSecurityService>|\Google\Protobuf\Internal\RepeatedField $var
@return $this | setNetworkEdgeSecurityServices | php | googleapis/google-cloud-php | Compute/src/V1/NetworkEdgeSecurityServicesScopedList.php | https://github.com/googleapis/google-cloud-php/blob/master/Compute/src/V1/NetworkEdgeSecurityServicesScopedList.php | Apache-2.0 |
public function getWarning()
{
return $this->warning;
} | Informational warning which replaces the list of security policies when the list is empty.
Generated from protobuf field <code>optional .google.cloud.compute.v1.Warning warning = 50704284;</code>
@return \Google\Cloud\Compute\V1\Warning|null | getWarning | php | googleapis/google-cloud-php | Compute/src/V1/NetworkEdgeSecurityServicesScopedList.php | https://github.com/googleapis/google-cloud-php/blob/master/Compute/src/V1/NetworkEdgeSecurityServicesScopedList.php | Apache-2.0 |
public function setWarning($var)
{
GPBUtil::checkMessage($var, \Google\Cloud\Compute\V1\Warning::class);
$this->warning = $var;
return $this;
} | Informational warning which replaces the list of security policies when the list is empty.
Generated from protobuf field <code>optional .google.cloud.compute.v1.Warning warning = 50704284;</code>
@param \Google\Cloud\Compute\V1\Warning $var
@return $this | setWarning | php | googleapis/google-cloud-php | Compute/src/V1/NetworkEdgeSecurityServicesScopedList.php | https://github.com/googleapis/google-cloud-php/blob/master/Compute/src/V1/NetworkEdgeSecurityServicesScopedList.php | Apache-2.0 |
public function getQueryFileUri()
{
return $this->readOneof(1);
} | The HCFS URI of the script that contains SQL queries.
Generated from protobuf field <code>string query_file_uri = 1;</code>
@return string | getQueryFileUri | php | googleapis/google-cloud-php | Dataproc/src/V1/TrinoJob.php | https://github.com/googleapis/google-cloud-php/blob/master/Dataproc/src/V1/TrinoJob.php | Apache-2.0 |
public function setQueryFileUri($var)
{
GPBUtil::checkString($var, True);
$this->writeOneof(1, $var);
return $this;
} | The HCFS URI of the script that contains SQL queries.
Generated from protobuf field <code>string query_file_uri = 1;</code>
@param string $var
@return $this | setQueryFileUri | php | googleapis/google-cloud-php | Dataproc/src/V1/TrinoJob.php | https://github.com/googleapis/google-cloud-php/blob/master/Dataproc/src/V1/TrinoJob.php | Apache-2.0 |
public function getQueryList()
{
return $this->readOneof(2);
} | A list of queries.
Generated from protobuf field <code>.google.cloud.dataproc.v1.QueryList query_list = 2;</code>
@return \Google\Cloud\Dataproc\V1\QueryList|null | getQueryList | php | googleapis/google-cloud-php | Dataproc/src/V1/TrinoJob.php | https://github.com/googleapis/google-cloud-php/blob/master/Dataproc/src/V1/TrinoJob.php | Apache-2.0 |
public function setQueryList($var)
{
GPBUtil::checkMessage($var, \Google\Cloud\Dataproc\V1\QueryList::class);
$this->writeOneof(2, $var);
return $this;
} | A list of queries.
Generated from protobuf field <code>.google.cloud.dataproc.v1.QueryList query_list = 2;</code>
@param \Google\Cloud\Dataproc\V1\QueryList $var
@return $this | setQueryList | php | googleapis/google-cloud-php | Dataproc/src/V1/TrinoJob.php | https://github.com/googleapis/google-cloud-php/blob/master/Dataproc/src/V1/TrinoJob.php | Apache-2.0 |
public function getContinueOnFailure()
{
return $this->continue_on_failure;
} | Optional. Whether to continue executing queries if a query fails.
The default value is `false`. Setting to `true` can be useful when
executing independent parallel queries.
Generated from protobuf field <code>bool continue_on_failure = 3 [(.google.api.field_behavior) = OPTIONAL];</code>
@return bool | getContinueOnFailure | php | googleapis/google-cloud-php | Dataproc/src/V1/TrinoJob.php | https://github.com/googleapis/google-cloud-php/blob/master/Dataproc/src/V1/TrinoJob.php | Apache-2.0 |
public function setContinueOnFailure($var)
{
GPBUtil::checkBool($var);
$this->continue_on_failure = $var;
return $this;
} | Optional. Whether to continue executing queries if a query fails.
The default value is `false`. Setting to `true` can be useful when
executing independent parallel queries.
Generated from protobuf field <code>bool continue_on_failure = 3 [(.google.api.field_behavior) = OPTIONAL];</code>
@param bool $var
@return $this | setContinueOnFailure | php | googleapis/google-cloud-php | Dataproc/src/V1/TrinoJob.php | https://github.com/googleapis/google-cloud-php/blob/master/Dataproc/src/V1/TrinoJob.php | Apache-2.0 |
public function getOutputFormat()
{
return $this->output_format;
} | Optional. The format in which query output will be displayed. See the
Trino documentation for supported output formats
Generated from protobuf field <code>string output_format = 4 [(.google.api.field_behavior) = OPTIONAL];</code>
@return string | getOutputFormat | php | googleapis/google-cloud-php | Dataproc/src/V1/TrinoJob.php | https://github.com/googleapis/google-cloud-php/blob/master/Dataproc/src/V1/TrinoJob.php | Apache-2.0 |
public function setOutputFormat($var)
{
GPBUtil::checkString($var, True);
$this->output_format = $var;
return $this;
} | Optional. The format in which query output will be displayed. See the
Trino documentation for supported output formats
Generated from protobuf field <code>string output_format = 4 [(.google.api.field_behavior) = OPTIONAL];</code>
@param string $var
@return $this | setOutputFormat | php | googleapis/google-cloud-php | Dataproc/src/V1/TrinoJob.php | https://github.com/googleapis/google-cloud-php/blob/master/Dataproc/src/V1/TrinoJob.php | Apache-2.0 |
public function getClientTags()
{
return $this->client_tags;
} | Optional. Trino client tags to attach to this query
Generated from protobuf field <code>repeated string client_tags = 5 [(.google.api.field_behavior) = OPTIONAL];</code>
@return \Google\Protobuf\Internal\RepeatedField | getClientTags | php | googleapis/google-cloud-php | Dataproc/src/V1/TrinoJob.php | https://github.com/googleapis/google-cloud-php/blob/master/Dataproc/src/V1/TrinoJob.php | Apache-2.0 |
public function setClientTags($var)
{
$arr = GPBUtil::checkRepeatedField($var, \Google\Protobuf\Internal\GPBType::STRING);
$this->client_tags = $arr;
return $this;
} | Optional. Trino client tags to attach to this query
Generated from protobuf field <code>repeated string client_tags = 5 [(.google.api.field_behavior) = OPTIONAL];</code>
@param array<string>|\Google\Protobuf\Internal\RepeatedField $var
@return $this | setClientTags | php | googleapis/google-cloud-php | Dataproc/src/V1/TrinoJob.php | https://github.com/googleapis/google-cloud-php/blob/master/Dataproc/src/V1/TrinoJob.php | Apache-2.0 |
public function getProperties()
{
return $this->properties;
} | Optional. A mapping of property names to values. Used to set Trino
[session properties](https://trino.io/docs/current/sql/set-session.html)
Equivalent to using the --session flag in the Trino CLI
Generated from protobuf field <code>map<string, string> properties = 6 [(.google.api.field_behavior) = OPTIONAL];</code>
@return \Google\Protobuf\Internal\MapField | getProperties | php | googleapis/google-cloud-php | Dataproc/src/V1/TrinoJob.php | https://github.com/googleapis/google-cloud-php/blob/master/Dataproc/src/V1/TrinoJob.php | Apache-2.0 |
public function setProperties($var)
{
$arr = GPBUtil::checkMapField($var, \Google\Protobuf\Internal\GPBType::STRING, \Google\Protobuf\Internal\GPBType::STRING);
$this->properties = $arr;
return $this;
} | Optional. A mapping of property names to values. Used to set Trino
[session properties](https://trino.io/docs/current/sql/set-session.html)
Equivalent to using the --session flag in the Trino CLI
Generated from protobuf field <code>map<string, string> properties = 6 [(.google.api.field_behavior) = OPTIONAL];</code>
@param array|\Google\Protobuf\Internal\MapField $var
@return $this | setProperties | php | googleapis/google-cloud-php | Dataproc/src/V1/TrinoJob.php | https://github.com/googleapis/google-cloud-php/blob/master/Dataproc/src/V1/TrinoJob.php | Apache-2.0 |
public function getLoggingConfig()
{
return $this->logging_config;
} | Optional. The runtime log config for job execution.
Generated from protobuf field <code>.google.cloud.dataproc.v1.LoggingConfig logging_config = 7 [(.google.api.field_behavior) = OPTIONAL];</code>
@return \Google\Cloud\Dataproc\V1\LoggingConfig|null | getLoggingConfig | php | googleapis/google-cloud-php | Dataproc/src/V1/TrinoJob.php | https://github.com/googleapis/google-cloud-php/blob/master/Dataproc/src/V1/TrinoJob.php | Apache-2.0 |
public function setLoggingConfig($var)
{
GPBUtil::checkMessage($var, \Google\Cloud\Dataproc\V1\LoggingConfig::class);
$this->logging_config = $var;
return $this;
} | Optional. The runtime log config for job execution.
Generated from protobuf field <code>.google.cloud.dataproc.v1.LoggingConfig logging_config = 7 [(.google.api.field_behavior) = OPTIONAL];</code>
@param \Google\Cloud\Dataproc\V1\LoggingConfig $var
@return $this | setLoggingConfig | php | googleapis/google-cloud-php | Dataproc/src/V1/TrinoJob.php | https://github.com/googleapis/google-cloud-php/blob/master/Dataproc/src/V1/TrinoJob.php | Apache-2.0 |
public function getSubscriptions()
{
return $this->subscriptions;
} | The list of subscriptions.
Generated from protobuf field <code>repeated .google.cloud.bigquery.analyticshub.v1.Subscription subscriptions = 1;</code>
@return \Google\Protobuf\Internal\RepeatedField | getSubscriptions | php | googleapis/google-cloud-php | BigQueryAnalyticsHub/src/V1/ListSubscriptionsResponse.php | https://github.com/googleapis/google-cloud-php/blob/master/BigQueryAnalyticsHub/src/V1/ListSubscriptionsResponse.php | Apache-2.0 |
public function setSubscriptions($var)
{
$arr = GPBUtil::checkRepeatedField($var, \Google\Protobuf\Internal\GPBType::MESSAGE, \Google\Cloud\BigQuery\AnalyticsHub\V1\Subscription::class);
$this->subscriptions = $arr;
return $this;
} | The list of subscriptions.
Generated from protobuf field <code>repeated .google.cloud.bigquery.analyticshub.v1.Subscription subscriptions = 1;</code>
@param array<\Google\Cloud\BigQuery\AnalyticsHub\V1\Subscription>|\Google\Protobuf\Internal\RepeatedField $var
@return $this | setSubscriptions | php | googleapis/google-cloud-php | BigQueryAnalyticsHub/src/V1/ListSubscriptionsResponse.php | https://github.com/googleapis/google-cloud-php/blob/master/BigQueryAnalyticsHub/src/V1/ListSubscriptionsResponse.php | Apache-2.0 |
public function getNextPageToken()
{
return $this->next_page_token;
} | Next page token.
Generated from protobuf field <code>string next_page_token = 2;</code>
@return string | getNextPageToken | php | googleapis/google-cloud-php | BigQueryAnalyticsHub/src/V1/ListSubscriptionsResponse.php | https://github.com/googleapis/google-cloud-php/blob/master/BigQueryAnalyticsHub/src/V1/ListSubscriptionsResponse.php | Apache-2.0 |
public function setNextPageToken($var)
{
GPBUtil::checkString($var, True);
$this->next_page_token = $var;
return $this;
} | Next page token.
Generated from protobuf field <code>string next_page_token = 2;</code>
@param string $var
@return $this | setNextPageToken | php | googleapis/google-cloud-php | BigQueryAnalyticsHub/src/V1/ListSubscriptionsResponse.php | https://github.com/googleapis/google-cloud-php/blob/master/BigQueryAnalyticsHub/src/V1/ListSubscriptionsResponse.php | Apache-2.0 |
public function getPromoteAutomationRun()
{
return $this->promote_automation_run;
} | Output only. The name of the AutomationRun initiated by a promote release
rule.
Generated from protobuf field <code>string promote_automation_run = 1 [(.google.api.field_behavior) = OUTPUT_ONLY];</code>
@return string | getPromoteAutomationRun | php | googleapis/google-cloud-php | Deploy/src/V1/AutomationRolloutMetadata.php | https://github.com/googleapis/google-cloud-php/blob/master/Deploy/src/V1/AutomationRolloutMetadata.php | Apache-2.0 |
public function setPromoteAutomationRun($var)
{
GPBUtil::checkString($var, True);
$this->promote_automation_run = $var;
return $this;
} | Output only. The name of the AutomationRun initiated by a promote release
rule.
Generated from protobuf field <code>string promote_automation_run = 1 [(.google.api.field_behavior) = OUTPUT_ONLY];</code>
@param string $var
@return $this | setPromoteAutomationRun | php | googleapis/google-cloud-php | Deploy/src/V1/AutomationRolloutMetadata.php | https://github.com/googleapis/google-cloud-php/blob/master/Deploy/src/V1/AutomationRolloutMetadata.php | Apache-2.0 |
public function getAdvanceAutomationRuns()
{
return $this->advance_automation_runs;
} | Output only. The names of the AutomationRuns initiated by an advance
rollout rule.
Generated from protobuf field <code>repeated string advance_automation_runs = 2 [(.google.api.field_behavior) = OUTPUT_ONLY];</code>
@return \Google\Protobuf\Internal\RepeatedField | getAdvanceAutomationRuns | php | googleapis/google-cloud-php | Deploy/src/V1/AutomationRolloutMetadata.php | https://github.com/googleapis/google-cloud-php/blob/master/Deploy/src/V1/AutomationRolloutMetadata.php | Apache-2.0 |
public function setAdvanceAutomationRuns($var)
{
$arr = GPBUtil::checkRepeatedField($var, \Google\Protobuf\Internal\GPBType::STRING);
$this->advance_automation_runs = $arr;
return $this;
} | Output only. The names of the AutomationRuns initiated by an advance
rollout rule.
Generated from protobuf field <code>repeated string advance_automation_runs = 2 [(.google.api.field_behavior) = OUTPUT_ONLY];</code>
@param array<string>|\Google\Protobuf\Internal\RepeatedField $var
@return $this | setAdvanceAutomationRuns | php | googleapis/google-cloud-php | Deploy/src/V1/AutomationRolloutMetadata.php | https://github.com/googleapis/google-cloud-php/blob/master/Deploy/src/V1/AutomationRolloutMetadata.php | Apache-2.0 |
public function getRepairAutomationRuns()
{
return $this->repair_automation_runs;
} | Output only. The names of the AutomationRuns initiated by a repair rollout
rule.
Generated from protobuf field <code>repeated string repair_automation_runs = 3 [(.google.api.field_behavior) = OUTPUT_ONLY];</code>
@return \Google\Protobuf\Internal\RepeatedField | getRepairAutomationRuns | php | googleapis/google-cloud-php | Deploy/src/V1/AutomationRolloutMetadata.php | https://github.com/googleapis/google-cloud-php/blob/master/Deploy/src/V1/AutomationRolloutMetadata.php | Apache-2.0 |
public function setRepairAutomationRuns($var)
{
$arr = GPBUtil::checkRepeatedField($var, \Google\Protobuf\Internal\GPBType::STRING);
$this->repair_automation_runs = $arr;
return $this;
} | Output only. The names of the AutomationRuns initiated by a repair rollout
rule.
Generated from protobuf field <code>repeated string repair_automation_runs = 3 [(.google.api.field_behavior) = OUTPUT_ONLY];</code>
@param array<string>|\Google\Protobuf\Internal\RepeatedField $var
@return $this | setRepairAutomationRuns | php | googleapis/google-cloud-php | Deploy/src/V1/AutomationRolloutMetadata.php | https://github.com/googleapis/google-cloud-php/blob/master/Deploy/src/V1/AutomationRolloutMetadata.php | Apache-2.0 |
public function getStartTimeOffset()
{
return $this->start_time_offset;
} | Start of the time segment (inclusive), represented as the duration since
the example start.
Generated from protobuf field <code>.google.protobuf.Duration start_time_offset = 1;</code>
@return \Google\Protobuf\Duration|null | getStartTimeOffset | php | googleapis/google-cloud-php | DataLabeling/src/V1beta1/TimeSegment.php | https://github.com/googleapis/google-cloud-php/blob/master/DataLabeling/src/V1beta1/TimeSegment.php | Apache-2.0 |
public function setStartTimeOffset($var)
{
GPBUtil::checkMessage($var, \Google\Protobuf\Duration::class);
$this->start_time_offset = $var;
return $this;
} | Start of the time segment (inclusive), represented as the duration since
the example start.
Generated from protobuf field <code>.google.protobuf.Duration start_time_offset = 1;</code>
@param \Google\Protobuf\Duration $var
@return $this | setStartTimeOffset | php | googleapis/google-cloud-php | DataLabeling/src/V1beta1/TimeSegment.php | https://github.com/googleapis/google-cloud-php/blob/master/DataLabeling/src/V1beta1/TimeSegment.php | Apache-2.0 |
public function getEndTimeOffset()
{
return $this->end_time_offset;
} | End of the time segment (exclusive), represented as the duration since the
example start.
Generated from protobuf field <code>.google.protobuf.Duration end_time_offset = 2;</code>
@return \Google\Protobuf\Duration|null | getEndTimeOffset | php | googleapis/google-cloud-php | DataLabeling/src/V1beta1/TimeSegment.php | https://github.com/googleapis/google-cloud-php/blob/master/DataLabeling/src/V1beta1/TimeSegment.php | Apache-2.0 |
public function setEndTimeOffset($var)
{
GPBUtil::checkMessage($var, \Google\Protobuf\Duration::class);
$this->end_time_offset = $var;
return $this;
} | End of the time segment (exclusive), represented as the duration since the
example start.
Generated from protobuf field <code>.google.protobuf.Duration end_time_offset = 2;</code>
@param \Google\Protobuf\Duration $var
@return $this | setEndTimeOffset | php | googleapis/google-cloud-php | DataLabeling/src/V1beta1/TimeSegment.php | https://github.com/googleapis/google-cloud-php/blob/master/DataLabeling/src/V1beta1/TimeSegment.php | Apache-2.0 |
public function getCustomClass()
{
return $this->custom_class;
} | Required. The CustomClass to update.
The CustomClass's `name` field is used to identify the CustomClass to
update. Format:
`projects/{project}/locations/{location}/customClasses/{custom_class}`.
Generated from protobuf field <code>.google.cloud.speech.v2.CustomClass custom_class = 1 [(.google.api.field_behavior) = REQUIRED];</code>
@return \Google\Cloud\Speech\V2\CustomClass|null | getCustomClass | php | googleapis/google-cloud-php | Speech/src/V2/UpdateCustomClassRequest.php | https://github.com/googleapis/google-cloud-php/blob/master/Speech/src/V2/UpdateCustomClassRequest.php | Apache-2.0 |
public function setCustomClass($var)
{
GPBUtil::checkMessage($var, \Google\Cloud\Speech\V2\CustomClass::class);
$this->custom_class = $var;
return $this;
} | Required. The CustomClass to update.
The CustomClass's `name` field is used to identify the CustomClass to
update. Format:
`projects/{project}/locations/{location}/customClasses/{custom_class}`.
Generated from protobuf field <code>.google.cloud.speech.v2.CustomClass custom_class = 1 [(.google.api.field_behavior) = REQUIRED];</code>
@param \Google\Cloud\Speech\V2\CustomClass $var
@return $this | setCustomClass | php | googleapis/google-cloud-php | Speech/src/V2/UpdateCustomClassRequest.php | https://github.com/googleapis/google-cloud-php/blob/master/Speech/src/V2/UpdateCustomClassRequest.php | Apache-2.0 |
public function getUpdateMask()
{
return $this->update_mask;
} | The list of fields to be updated. If empty, all fields are considered for
update.
Generated from protobuf field <code>.google.protobuf.FieldMask update_mask = 2;</code>
@return \Google\Protobuf\FieldMask|null | getUpdateMask | php | googleapis/google-cloud-php | Speech/src/V2/UpdateCustomClassRequest.php | https://github.com/googleapis/google-cloud-php/blob/master/Speech/src/V2/UpdateCustomClassRequest.php | Apache-2.0 |
public function setUpdateMask($var)
{
GPBUtil::checkMessage($var, \Google\Protobuf\FieldMask::class);
$this->update_mask = $var;
return $this;
} | The list of fields to be updated. If empty, all fields are considered for
update.
Generated from protobuf field <code>.google.protobuf.FieldMask update_mask = 2;</code>
@param \Google\Protobuf\FieldMask $var
@return $this | setUpdateMask | php | googleapis/google-cloud-php | Speech/src/V2/UpdateCustomClassRequest.php | https://github.com/googleapis/google-cloud-php/blob/master/Speech/src/V2/UpdateCustomClassRequest.php | Apache-2.0 |
public function getValidateOnly()
{
return $this->validate_only;
} | If set, validate the request and preview the updated CustomClass, but do
not actually update it.
Generated from protobuf field <code>bool validate_only = 4;</code>
@return bool | getValidateOnly | php | googleapis/google-cloud-php | Speech/src/V2/UpdateCustomClassRequest.php | https://github.com/googleapis/google-cloud-php/blob/master/Speech/src/V2/UpdateCustomClassRequest.php | Apache-2.0 |
public function setValidateOnly($var)
{
GPBUtil::checkBool($var);
$this->validate_only = $var;
return $this;
} | If set, validate the request and preview the updated CustomClass, but do
not actually update it.
Generated from protobuf field <code>bool validate_only = 4;</code>
@param bool $var
@return $this | setValidateOnly | php | googleapis/google-cloud-php | Speech/src/V2/UpdateCustomClassRequest.php | https://github.com/googleapis/google-cloud-php/blob/master/Speech/src/V2/UpdateCustomClassRequest.php | Apache-2.0 |
public function getFiles()
{
return $this->files;
} | The files returned.
Generated from protobuf field <code>repeated .google.devtools.artifactregistry.v1.File files = 1;</code>
@return \Google\Protobuf\Internal\RepeatedField | getFiles | php | googleapis/google-cloud-php | ArtifactRegistry/src/V1/ListFilesResponse.php | https://github.com/googleapis/google-cloud-php/blob/master/ArtifactRegistry/src/V1/ListFilesResponse.php | Apache-2.0 |
public function setFiles($var)
{
$arr = GPBUtil::checkRepeatedField($var, \Google\Protobuf\Internal\GPBType::MESSAGE, \Google\Cloud\ArtifactRegistry\V1\File::class);
$this->files = $arr;
return $this;
} | The files returned.
Generated from protobuf field <code>repeated .google.devtools.artifactregistry.v1.File files = 1;</code>
@param array<\Google\Cloud\ArtifactRegistry\V1\File>|\Google\Protobuf\Internal\RepeatedField $var
@return $this | setFiles | php | googleapis/google-cloud-php | ArtifactRegistry/src/V1/ListFilesResponse.php | https://github.com/googleapis/google-cloud-php/blob/master/ArtifactRegistry/src/V1/ListFilesResponse.php | Apache-2.0 |
public function getNextPageToken()
{
return $this->next_page_token;
} | The token to retrieve the next page of files, or empty if there are no
more files to return.
Generated from protobuf field <code>string next_page_token = 2;</code>
@return string | getNextPageToken | php | googleapis/google-cloud-php | ArtifactRegistry/src/V1/ListFilesResponse.php | https://github.com/googleapis/google-cloud-php/blob/master/ArtifactRegistry/src/V1/ListFilesResponse.php | Apache-2.0 |
public function setNextPageToken($var)
{
GPBUtil::checkString($var, True);
$this->next_page_token = $var;
return $this;
} | The token to retrieve the next page of files, or empty if there are no
more files to return.
Generated from protobuf field <code>string next_page_token = 2;</code>
@param string $var
@return $this | setNextPageToken | php | googleapis/google-cloud-php | ArtifactRegistry/src/V1/ListFilesResponse.php | https://github.com/googleapis/google-cloud-php/blob/master/ArtifactRegistry/src/V1/ListFilesResponse.php | Apache-2.0 |
public function getConsumed()
{
return $this->consumed;
} | Quota consumed by this request.
Generated from protobuf field <code>int32 consumed = 1;</code>
@return int | getConsumed | php | googleapis/google-cloud-php | AnalyticsAdmin/src/V1alpha/AccessQuotaStatus.php | https://github.com/googleapis/google-cloud-php/blob/master/AnalyticsAdmin/src/V1alpha/AccessQuotaStatus.php | Apache-2.0 |
public function setConsumed($var)
{
GPBUtil::checkInt32($var);
$this->consumed = $var;
return $this;
} | Quota consumed by this request.
Generated from protobuf field <code>int32 consumed = 1;</code>
@param int $var
@return $this | setConsumed | php | googleapis/google-cloud-php | AnalyticsAdmin/src/V1alpha/AccessQuotaStatus.php | https://github.com/googleapis/google-cloud-php/blob/master/AnalyticsAdmin/src/V1alpha/AccessQuotaStatus.php | Apache-2.0 |
public function getRemaining()
{
return $this->remaining;
} | Quota remaining after this request.
Generated from protobuf field <code>int32 remaining = 2;</code>
@return int | getRemaining | php | googleapis/google-cloud-php | AnalyticsAdmin/src/V1alpha/AccessQuotaStatus.php | https://github.com/googleapis/google-cloud-php/blob/master/AnalyticsAdmin/src/V1alpha/AccessQuotaStatus.php | Apache-2.0 |
public function setRemaining($var)
{
GPBUtil::checkInt32($var);
$this->remaining = $var;
return $this;
} | Quota remaining after this request.
Generated from protobuf field <code>int32 remaining = 2;</code>
@param int $var
@return $this | setRemaining | php | googleapis/google-cloud-php | AnalyticsAdmin/src/V1alpha/AccessQuotaStatus.php | https://github.com/googleapis/google-cloud-php/blob/master/AnalyticsAdmin/src/V1alpha/AccessQuotaStatus.php | Apache-2.0 |
public function getParent()
{
return $this->parent;
} | Required. Target project or location to make a call.
Format:
* `projects/{project-id}`
* `projects/{project-id}/locations/{location-id}`
If no location is specified, a region will be chosen automatically.
Generated from protobuf field <code>string parent = 1 [(.google.api.field_behavior) = REQUIRED];</code>
@return string | getParent | php | googleapis/google-cloud-php | MapsRouteOptimization/src/V1/OptimizeToursRequest.php | https://github.com/googleapis/google-cloud-php/blob/master/MapsRouteOptimization/src/V1/OptimizeToursRequest.php | Apache-2.0 |
public function setParent($var)
{
GPBUtil::checkString($var, True);
$this->parent = $var;
return $this;
} | Required. Target project or location to make a call.
Format:
* `projects/{project-id}`
* `projects/{project-id}/locations/{location-id}`
If no location is specified, a region will be chosen automatically.
Generated from protobuf field <code>string parent = 1 [(.google.api.field_behavior) = REQUIRED];</code>
@param string $var
@return $this | setParent | php | googleapis/google-cloud-php | MapsRouteOptimization/src/V1/OptimizeToursRequest.php | https://github.com/googleapis/google-cloud-php/blob/master/MapsRouteOptimization/src/V1/OptimizeToursRequest.php | Apache-2.0 |
public function getTimeout()
{
return $this->timeout;
} | If this timeout is set, the server returns a response before the timeout
period has elapsed or the server deadline for synchronous requests is
reached, whichever is sooner.
For asynchronous requests, the server will generate a solution (if
possible) before the timeout has elapsed.
Generated from protobuf field <code>.google.protobuf.Duration timeout = 2;</code>
@return \Google\Protobuf\Duration|null | getTimeout | php | googleapis/google-cloud-php | MapsRouteOptimization/src/V1/OptimizeToursRequest.php | https://github.com/googleapis/google-cloud-php/blob/master/MapsRouteOptimization/src/V1/OptimizeToursRequest.php | Apache-2.0 |
public function setTimeout($var)
{
GPBUtil::checkMessage($var, \Google\Protobuf\Duration::class);
$this->timeout = $var;
return $this;
} | If this timeout is set, the server returns a response before the timeout
period has elapsed or the server deadline for synchronous requests is
reached, whichever is sooner.
For asynchronous requests, the server will generate a solution (if
possible) before the timeout has elapsed.
Generated from protobuf field <code>.google.protobuf.Duration timeout = 2;</code>
@param \Google\Protobuf\Duration $var
@return $this | setTimeout | php | googleapis/google-cloud-php | MapsRouteOptimization/src/V1/OptimizeToursRequest.php | https://github.com/googleapis/google-cloud-php/blob/master/MapsRouteOptimization/src/V1/OptimizeToursRequest.php | Apache-2.0 |
public function getModel()
{
return $this->model;
} | Shipment model to solve.
Generated from protobuf field <code>.google.maps.routeoptimization.v1.ShipmentModel model = 3;</code>
@return \Google\Maps\RouteOptimization\V1\ShipmentModel|null | getModel | php | googleapis/google-cloud-php | MapsRouteOptimization/src/V1/OptimizeToursRequest.php | https://github.com/googleapis/google-cloud-php/blob/master/MapsRouteOptimization/src/V1/OptimizeToursRequest.php | Apache-2.0 |
public function setModel($var)
{
GPBUtil::checkMessage($var, \Google\Maps\RouteOptimization\V1\ShipmentModel::class);
$this->model = $var;
return $this;
} | Shipment model to solve.
Generated from protobuf field <code>.google.maps.routeoptimization.v1.ShipmentModel model = 3;</code>
@param \Google\Maps\RouteOptimization\V1\ShipmentModel $var
@return $this | setModel | php | googleapis/google-cloud-php | MapsRouteOptimization/src/V1/OptimizeToursRequest.php | https://github.com/googleapis/google-cloud-php/blob/master/MapsRouteOptimization/src/V1/OptimizeToursRequest.php | Apache-2.0 |
public function getSolvingMode()
{
return $this->solving_mode;
} | By default, the solving mode is `DEFAULT_SOLVE` (0).
Generated from protobuf field <code>.google.maps.routeoptimization.v1.OptimizeToursRequest.SolvingMode solving_mode = 4;</code>
@return int | getSolvingMode | php | googleapis/google-cloud-php | MapsRouteOptimization/src/V1/OptimizeToursRequest.php | https://github.com/googleapis/google-cloud-php/blob/master/MapsRouteOptimization/src/V1/OptimizeToursRequest.php | Apache-2.0 |
public function setSolvingMode($var)
{
GPBUtil::checkEnum($var, \Google\Maps\RouteOptimization\V1\OptimizeToursRequest\SolvingMode::class);
$this->solving_mode = $var;
return $this;
} | By default, the solving mode is `DEFAULT_SOLVE` (0).
Generated from protobuf field <code>.google.maps.routeoptimization.v1.OptimizeToursRequest.SolvingMode solving_mode = 4;</code>
@param int $var
@return $this | setSolvingMode | php | googleapis/google-cloud-php | MapsRouteOptimization/src/V1/OptimizeToursRequest.php | https://github.com/googleapis/google-cloud-php/blob/master/MapsRouteOptimization/src/V1/OptimizeToursRequest.php | Apache-2.0 |
public function getSearchMode()
{
return $this->search_mode;
} | Search mode used to solve the request.
Generated from protobuf field <code>.google.maps.routeoptimization.v1.OptimizeToursRequest.SearchMode search_mode = 6;</code>
@return int | getSearchMode | php | googleapis/google-cloud-php | MapsRouteOptimization/src/V1/OptimizeToursRequest.php | https://github.com/googleapis/google-cloud-php/blob/master/MapsRouteOptimization/src/V1/OptimizeToursRequest.php | Apache-2.0 |
public function setSearchMode($var)
{
GPBUtil::checkEnum($var, \Google\Maps\RouteOptimization\V1\OptimizeToursRequest\SearchMode::class);
$this->search_mode = $var;
return $this;
} | Search mode used to solve the request.
Generated from protobuf field <code>.google.maps.routeoptimization.v1.OptimizeToursRequest.SearchMode search_mode = 6;</code>
@param int $var
@return $this | setSearchMode | php | googleapis/google-cloud-php | MapsRouteOptimization/src/V1/OptimizeToursRequest.php | https://github.com/googleapis/google-cloud-php/blob/master/MapsRouteOptimization/src/V1/OptimizeToursRequest.php | Apache-2.0 |
public function getInjectedFirstSolutionRoutes()
{
return $this->injected_first_solution_routes;
} | Guide the optimization algorithm in finding a first solution that is
similar to a previous solution.
The model is constrained when the first solution is built.
Any shipments not performed on a route are implicitly skipped in the first
solution, but they may be performed in successive solutions.
The solution must satisfy some basic validity assumptions:
* for all routes, `vehicle_index` must be in range and not be duplicated.
* for all visits, `shipment_index` and `visit_request_index` must be
in range.
* a shipment may only be referenced on one route.
* the pickup of a pickup-delivery shipment must be performed before
the delivery.
* no more than one pickup alternative or delivery alternative of
a shipment may be performed.
* for all routes, times are increasing (i.e., `vehicle_start_time
<= visits[0].start_time <= visits[1].start_time ...
<= vehicle_end_time`).
* a shipment may only be performed on a vehicle that is allowed. A
vehicle is allowed if
[Shipment.allowed_vehicle_indices][google.maps.routeoptimization.v1.Shipment.allowed_vehicle_indices]
is empty or its `vehicle_index` is included in
[Shipment.allowed_vehicle_indices][google.maps.routeoptimization.v1.Shipment.allowed_vehicle_indices].
If the injected solution is not feasible, a validation error is not
necessarily returned and an error indicating infeasibility may be returned
instead.
Generated from protobuf field <code>repeated .google.maps.routeoptimization.v1.ShipmentRoute injected_first_solution_routes = 7;</code>
@return \Google\Protobuf\Internal\RepeatedField | getInjectedFirstSolutionRoutes | php | googleapis/google-cloud-php | MapsRouteOptimization/src/V1/OptimizeToursRequest.php | https://github.com/googleapis/google-cloud-php/blob/master/MapsRouteOptimization/src/V1/OptimizeToursRequest.php | Apache-2.0 |
public function setInjectedFirstSolutionRoutes($var)
{
$arr = GPBUtil::checkRepeatedField($var, \Google\Protobuf\Internal\GPBType::MESSAGE, \Google\Maps\RouteOptimization\V1\ShipmentRoute::class);
$this->injected_first_solution_routes = $arr;
return $this;
} | Guide the optimization algorithm in finding a first solution that is
similar to a previous solution.
The model is constrained when the first solution is built.
Any shipments not performed on a route are implicitly skipped in the first
solution, but they may be performed in successive solutions.
The solution must satisfy some basic validity assumptions:
* for all routes, `vehicle_index` must be in range and not be duplicated.
* for all visits, `shipment_index` and `visit_request_index` must be
in range.
* a shipment may only be referenced on one route.
* the pickup of a pickup-delivery shipment must be performed before
the delivery.
* no more than one pickup alternative or delivery alternative of
a shipment may be performed.
* for all routes, times are increasing (i.e., `vehicle_start_time
<= visits[0].start_time <= visits[1].start_time ...
<= vehicle_end_time`).
* a shipment may only be performed on a vehicle that is allowed. A
vehicle is allowed if
[Shipment.allowed_vehicle_indices][google.maps.routeoptimization.v1.Shipment.allowed_vehicle_indices]
is empty or its `vehicle_index` is included in
[Shipment.allowed_vehicle_indices][google.maps.routeoptimization.v1.Shipment.allowed_vehicle_indices].
If the injected solution is not feasible, a validation error is not
necessarily returned and an error indicating infeasibility may be returned
instead.
Generated from protobuf field <code>repeated .google.maps.routeoptimization.v1.ShipmentRoute injected_first_solution_routes = 7;</code>
@param array<\Google\Maps\RouteOptimization\V1\ShipmentRoute>|\Google\Protobuf\Internal\RepeatedField $var
@return $this | setInjectedFirstSolutionRoutes | php | googleapis/google-cloud-php | MapsRouteOptimization/src/V1/OptimizeToursRequest.php | https://github.com/googleapis/google-cloud-php/blob/master/MapsRouteOptimization/src/V1/OptimizeToursRequest.php | Apache-2.0 |
public function getInjectedSolutionConstraint()
{
return $this->injected_solution_constraint;
} | Constrain the optimization algorithm to find a final solution that is
similar to a previous solution. For example, this may be used to freeze
portions of routes which have already been completed or which are to be
completed but must not be modified.
If the injected solution is not feasible, a validation error is not
necessarily returned and an error indicating infeasibility may be returned
instead.
Generated from protobuf field <code>.google.maps.routeoptimization.v1.InjectedSolutionConstraint injected_solution_constraint = 8;</code>
@return \Google\Maps\RouteOptimization\V1\InjectedSolutionConstraint|null | getInjectedSolutionConstraint | php | googleapis/google-cloud-php | MapsRouteOptimization/src/V1/OptimizeToursRequest.php | https://github.com/googleapis/google-cloud-php/blob/master/MapsRouteOptimization/src/V1/OptimizeToursRequest.php | Apache-2.0 |
public function setInjectedSolutionConstraint($var)
{
GPBUtil::checkMessage($var, \Google\Maps\RouteOptimization\V1\InjectedSolutionConstraint::class);
$this->injected_solution_constraint = $var;
return $this;
} | Constrain the optimization algorithm to find a final solution that is
similar to a previous solution. For example, this may be used to freeze
portions of routes which have already been completed or which are to be
completed but must not be modified.
If the injected solution is not feasible, a validation error is not
necessarily returned and an error indicating infeasibility may be returned
instead.
Generated from protobuf field <code>.google.maps.routeoptimization.v1.InjectedSolutionConstraint injected_solution_constraint = 8;</code>
@param \Google\Maps\RouteOptimization\V1\InjectedSolutionConstraint $var
@return $this | setInjectedSolutionConstraint | php | googleapis/google-cloud-php | MapsRouteOptimization/src/V1/OptimizeToursRequest.php | https://github.com/googleapis/google-cloud-php/blob/master/MapsRouteOptimization/src/V1/OptimizeToursRequest.php | Apache-2.0 |
public function getRefreshDetailsRoutes()
{
return $this->refresh_details_routes;
} | If non-empty, the given routes will be refreshed, without modifying their
underlying sequence of visits or travel times: only other details will be
updated. This does not solve the model.
As of 2020/11, this only populates the polylines of non-empty routes and
requires that `populate_polylines` is true.
The `route_polyline` fields of the passed-in routes may be inconsistent
with route `transitions`.
This field must not be used together with `injected_first_solution_routes`
or `injected_solution_constraint`.
`Shipment.ignore` and `Vehicle.ignore` have no effect on the behavior.
Polylines are still populated between all visits in all non-empty routes
regardless of whether the related shipments or vehicles are ignored.
Generated from protobuf field <code>repeated .google.maps.routeoptimization.v1.ShipmentRoute refresh_details_routes = 9;</code>
@return \Google\Protobuf\Internal\RepeatedField | getRefreshDetailsRoutes | php | googleapis/google-cloud-php | MapsRouteOptimization/src/V1/OptimizeToursRequest.php | https://github.com/googleapis/google-cloud-php/blob/master/MapsRouteOptimization/src/V1/OptimizeToursRequest.php | Apache-2.0 |
public function setRefreshDetailsRoutes($var)
{
$arr = GPBUtil::checkRepeatedField($var, \Google\Protobuf\Internal\GPBType::MESSAGE, \Google\Maps\RouteOptimization\V1\ShipmentRoute::class);
$this->refresh_details_routes = $arr;
return $this;
} | If non-empty, the given routes will be refreshed, without modifying their
underlying sequence of visits or travel times: only other details will be
updated. This does not solve the model.
As of 2020/11, this only populates the polylines of non-empty routes and
requires that `populate_polylines` is true.
The `route_polyline` fields of the passed-in routes may be inconsistent
with route `transitions`.
This field must not be used together with `injected_first_solution_routes`
or `injected_solution_constraint`.
`Shipment.ignore` and `Vehicle.ignore` have no effect on the behavior.
Polylines are still populated between all visits in all non-empty routes
regardless of whether the related shipments or vehicles are ignored.
Generated from protobuf field <code>repeated .google.maps.routeoptimization.v1.ShipmentRoute refresh_details_routes = 9;</code>
@param array<\Google\Maps\RouteOptimization\V1\ShipmentRoute>|\Google\Protobuf\Internal\RepeatedField $var
@return $this | setRefreshDetailsRoutes | php | googleapis/google-cloud-php | MapsRouteOptimization/src/V1/OptimizeToursRequest.php | https://github.com/googleapis/google-cloud-php/blob/master/MapsRouteOptimization/src/V1/OptimizeToursRequest.php | Apache-2.0 |
public function getConsiderRoadTraffic()
{
return $this->consider_road_traffic;
} | Consider traffic estimation in calculating `ShipmentRoute` fields
[Transition.travel_duration][google.maps.routeoptimization.v1.ShipmentRoute.Transition.travel_duration],
[Visit.start_time][google.maps.routeoptimization.v1.ShipmentRoute.Visit.start_time],
and `vehicle_end_time`; in setting the
[ShipmentRoute.has_traffic_infeasibilities][google.maps.routeoptimization.v1.ShipmentRoute.has_traffic_infeasibilities]
field, and in calculating the
[OptimizeToursResponse.total_cost][google.maps.routeoptimization.v1.OptimizeToursResponse.total_cost]
field.
Generated from protobuf field <code>bool consider_road_traffic = 11;</code>
@return bool | getConsiderRoadTraffic | php | googleapis/google-cloud-php | MapsRouteOptimization/src/V1/OptimizeToursRequest.php | https://github.com/googleapis/google-cloud-php/blob/master/MapsRouteOptimization/src/V1/OptimizeToursRequest.php | Apache-2.0 |
public function setConsiderRoadTraffic($var)
{
GPBUtil::checkBool($var);
$this->consider_road_traffic = $var;
return $this;
} | Consider traffic estimation in calculating `ShipmentRoute` fields
[Transition.travel_duration][google.maps.routeoptimization.v1.ShipmentRoute.Transition.travel_duration],
[Visit.start_time][google.maps.routeoptimization.v1.ShipmentRoute.Visit.start_time],
and `vehicle_end_time`; in setting the
[ShipmentRoute.has_traffic_infeasibilities][google.maps.routeoptimization.v1.ShipmentRoute.has_traffic_infeasibilities]
field, and in calculating the
[OptimizeToursResponse.total_cost][google.maps.routeoptimization.v1.OptimizeToursResponse.total_cost]
field.
Generated from protobuf field <code>bool consider_road_traffic = 11;</code>
@param bool $var
@return $this | setConsiderRoadTraffic | php | googleapis/google-cloud-php | MapsRouteOptimization/src/V1/OptimizeToursRequest.php | https://github.com/googleapis/google-cloud-php/blob/master/MapsRouteOptimization/src/V1/OptimizeToursRequest.php | Apache-2.0 |
public function getPopulatePolylines()
{
return $this->populate_polylines;
} | If true, polylines will be populated in response `ShipmentRoute`s.
Generated from protobuf field <code>bool populate_polylines = 12;</code>
@return bool | getPopulatePolylines | php | googleapis/google-cloud-php | MapsRouteOptimization/src/V1/OptimizeToursRequest.php | https://github.com/googleapis/google-cloud-php/blob/master/MapsRouteOptimization/src/V1/OptimizeToursRequest.php | Apache-2.0 |
public function setPopulatePolylines($var)
{
GPBUtil::checkBool($var);
$this->populate_polylines = $var;
return $this;
} | If true, polylines will be populated in response `ShipmentRoute`s.
Generated from protobuf field <code>bool populate_polylines = 12;</code>
@param bool $var
@return $this | setPopulatePolylines | php | googleapis/google-cloud-php | MapsRouteOptimization/src/V1/OptimizeToursRequest.php | https://github.com/googleapis/google-cloud-php/blob/master/MapsRouteOptimization/src/V1/OptimizeToursRequest.php | Apache-2.0 |
public function getPopulateTransitionPolylines()
{
return $this->populate_transition_polylines;
} | If true, polylines and route tokens will be populated in response
[ShipmentRoute.transitions][google.maps.routeoptimization.v1.ShipmentRoute.transitions].
Generated from protobuf field <code>bool populate_transition_polylines = 13;</code>
@return bool | getPopulateTransitionPolylines | php | googleapis/google-cloud-php | MapsRouteOptimization/src/V1/OptimizeToursRequest.php | https://github.com/googleapis/google-cloud-php/blob/master/MapsRouteOptimization/src/V1/OptimizeToursRequest.php | Apache-2.0 |
public function setPopulateTransitionPolylines($var)
{
GPBUtil::checkBool($var);
$this->populate_transition_polylines = $var;
return $this;
} | If true, polylines and route tokens will be populated in response
[ShipmentRoute.transitions][google.maps.routeoptimization.v1.ShipmentRoute.transitions].
Generated from protobuf field <code>bool populate_transition_polylines = 13;</code>
@param bool $var
@return $this | setPopulateTransitionPolylines | php | googleapis/google-cloud-php | MapsRouteOptimization/src/V1/OptimizeToursRequest.php | https://github.com/googleapis/google-cloud-php/blob/master/MapsRouteOptimization/src/V1/OptimizeToursRequest.php | Apache-2.0 |
public function getAllowLargeDeadlineDespiteInterruptionRisk()
{
return $this->allow_large_deadline_despite_interruption_risk;
} | If this is set, then the request can have a deadline
(see https://grpc.io/blog/deadlines) of up to 60 minutes.
Otherwise, the maximum deadline is only 30 minutes.
Note that long-lived requests have a significantly larger (but still small)
risk of interruption.
Generated from protobuf field <code>bool allow_large_deadline_despite_interruption_risk = 14;</code>
@return bool | getAllowLargeDeadlineDespiteInterruptionRisk | php | googleapis/google-cloud-php | MapsRouteOptimization/src/V1/OptimizeToursRequest.php | https://github.com/googleapis/google-cloud-php/blob/master/MapsRouteOptimization/src/V1/OptimizeToursRequest.php | Apache-2.0 |
Subsets and Splits
No community queries yet
The top public SQL queries from the community will appear here once available.