code
stringlengths 17
247k
| docstring
stringlengths 30
30.3k
| func_name
stringlengths 1
89
| language
stringclasses 1
value | repo
stringlengths 7
63
| path
stringlengths 7
153
| url
stringlengths 51
209
| license
stringclasses 4
values |
|---|---|---|---|---|---|---|---|
public function setKmsSettings($var)
{
@trigger_error('kms_settings is deprecated.', E_USER_DEPRECATED);
GPBUtil::checkMessage($var, \Google\Cloud\AssuredWorkloads\V1beta1\Workload\KMSSettings::class);
$this->kms_settings = $var;
return $this;
} | Input only. Settings used to create a CMEK crypto key. When set, a project with a KMS
CMEK key is provisioned.
This field is deprecated as of Feb 28, 2022.
In order to create a Keyring, callers should specify,
ENCRYPTION_KEYS_PROJECT or KEYRING in ResourceSettings.resource_type field.
Generated from protobuf field <code>.google.cloud.assuredworkloads.v1beta1.Workload.KMSSettings kms_settings = 14 [deprecated = true, (.google.api.field_behavior) = INPUT_ONLY];</code>
@param \Google\Cloud\AssuredWorkloads\V1beta1\Workload\KMSSettings $var
@return $this
@deprecated | setKmsSettings | php | googleapis/google-cloud-php | AssuredWorkloads/src/V1beta1/Workload.php | https://github.com/googleapis/google-cloud-php/blob/master/AssuredWorkloads/src/V1beta1/Workload.php | Apache-2.0 |
public function getResourceSettings()
{
return $this->resource_settings;
} | Input only. Resource properties that are used to customize workload resources.
These properties (such as custom project id) will be used to create
workload resources if possible. This field is optional.
Generated from protobuf field <code>repeated .google.cloud.assuredworkloads.v1beta1.Workload.ResourceSettings resource_settings = 15 [(.google.api.field_behavior) = INPUT_ONLY];</code>
@return \Google\Protobuf\Internal\RepeatedField | getResourceSettings | php | googleapis/google-cloud-php | AssuredWorkloads/src/V1beta1/Workload.php | https://github.com/googleapis/google-cloud-php/blob/master/AssuredWorkloads/src/V1beta1/Workload.php | Apache-2.0 |
public function setResourceSettings($var)
{
$arr = GPBUtil::checkRepeatedField($var, \Google\Protobuf\Internal\GPBType::MESSAGE, \Google\Cloud\AssuredWorkloads\V1beta1\Workload\ResourceSettings::class);
$this->resource_settings = $arr;
return $this;
} | Input only. Resource properties that are used to customize workload resources.
These properties (such as custom project id) will be used to create
workload resources if possible. This field is optional.
Generated from protobuf field <code>repeated .google.cloud.assuredworkloads.v1beta1.Workload.ResourceSettings resource_settings = 15 [(.google.api.field_behavior) = INPUT_ONLY];</code>
@param array<\Google\Cloud\AssuredWorkloads\V1beta1\Workload\ResourceSettings>|\Google\Protobuf\Internal\RepeatedField $var
@return $this | setResourceSettings | php | googleapis/google-cloud-php | AssuredWorkloads/src/V1beta1/Workload.php | https://github.com/googleapis/google-cloud-php/blob/master/AssuredWorkloads/src/V1beta1/Workload.php | Apache-2.0 |
public function getKajEnrollmentState()
{
return $this->kaj_enrollment_state;
} | Output only. Represents the KAJ enrollment state of the given workload.
Generated from protobuf field <code>.google.cloud.assuredworkloads.v1beta1.Workload.KajEnrollmentState kaj_enrollment_state = 17 [(.google.api.field_behavior) = OUTPUT_ONLY];</code>
@return int | getKajEnrollmentState | php | googleapis/google-cloud-php | AssuredWorkloads/src/V1beta1/Workload.php | https://github.com/googleapis/google-cloud-php/blob/master/AssuredWorkloads/src/V1beta1/Workload.php | Apache-2.0 |
public function setKajEnrollmentState($var)
{
GPBUtil::checkEnum($var, \Google\Cloud\AssuredWorkloads\V1beta1\Workload\KajEnrollmentState::class);
$this->kaj_enrollment_state = $var;
return $this;
} | Output only. Represents the KAJ enrollment state of the given workload.
Generated from protobuf field <code>.google.cloud.assuredworkloads.v1beta1.Workload.KajEnrollmentState kaj_enrollment_state = 17 [(.google.api.field_behavior) = OUTPUT_ONLY];</code>
@param int $var
@return $this | setKajEnrollmentState | php | googleapis/google-cloud-php | AssuredWorkloads/src/V1beta1/Workload.php | https://github.com/googleapis/google-cloud-php/blob/master/AssuredWorkloads/src/V1beta1/Workload.php | Apache-2.0 |
public function getEnableSovereignControls()
{
return $this->enable_sovereign_controls;
} | Optional. Indicates the sovereignty status of the given workload.
Currently meant to be used by Europe/Canada customers.
Generated from protobuf field <code>bool enable_sovereign_controls = 18 [(.google.api.field_behavior) = OPTIONAL];</code>
@return bool | getEnableSovereignControls | php | googleapis/google-cloud-php | AssuredWorkloads/src/V1beta1/Workload.php | https://github.com/googleapis/google-cloud-php/blob/master/AssuredWorkloads/src/V1beta1/Workload.php | Apache-2.0 |
public function setEnableSovereignControls($var)
{
GPBUtil::checkBool($var);
$this->enable_sovereign_controls = $var;
return $this;
} | Optional. Indicates the sovereignty status of the given workload.
Currently meant to be used by Europe/Canada customers.
Generated from protobuf field <code>bool enable_sovereign_controls = 18 [(.google.api.field_behavior) = OPTIONAL];</code>
@param bool $var
@return $this | setEnableSovereignControls | php | googleapis/google-cloud-php | AssuredWorkloads/src/V1beta1/Workload.php | https://github.com/googleapis/google-cloud-php/blob/master/AssuredWorkloads/src/V1beta1/Workload.php | Apache-2.0 |
public function getSaaEnrollmentResponse()
{
return $this->saa_enrollment_response;
} | Output only. Represents the SAA enrollment response of the given workload.
SAA enrollment response is queried during GetWorkload call.
In failure cases, user friendly error message is shown in SAA details page.
Generated from protobuf field <code>.google.cloud.assuredworkloads.v1beta1.Workload.SaaEnrollmentResponse saa_enrollment_response = 20 [(.google.api.field_behavior) = OUTPUT_ONLY];</code>
@return \Google\Cloud\AssuredWorkloads\V1beta1\Workload\SaaEnrollmentResponse|null | getSaaEnrollmentResponse | php | googleapis/google-cloud-php | AssuredWorkloads/src/V1beta1/Workload.php | https://github.com/googleapis/google-cloud-php/blob/master/AssuredWorkloads/src/V1beta1/Workload.php | Apache-2.0 |
public function setSaaEnrollmentResponse($var)
{
GPBUtil::checkMessage($var, \Google\Cloud\AssuredWorkloads\V1beta1\Workload\SaaEnrollmentResponse::class);
$this->saa_enrollment_response = $var;
return $this;
} | Output only. Represents the SAA enrollment response of the given workload.
SAA enrollment response is queried during GetWorkload call.
In failure cases, user friendly error message is shown in SAA details page.
Generated from protobuf field <code>.google.cloud.assuredworkloads.v1beta1.Workload.SaaEnrollmentResponse saa_enrollment_response = 20 [(.google.api.field_behavior) = OUTPUT_ONLY];</code>
@param \Google\Cloud\AssuredWorkloads\V1beta1\Workload\SaaEnrollmentResponse $var
@return $this | setSaaEnrollmentResponse | php | googleapis/google-cloud-php | AssuredWorkloads/src/V1beta1/Workload.php | https://github.com/googleapis/google-cloud-php/blob/master/AssuredWorkloads/src/V1beta1/Workload.php | Apache-2.0 |
public function getCompliantButDisallowedServices()
{
return $this->compliant_but_disallowed_services;
} | Output only. Urls for services which are compliant for this Assured Workload, but which
are currently disallowed by the ResourceUsageRestriction org policy.
Invoke RestrictAllowedResources endpoint to allow your project developers
to use these services in their environment."
Generated from protobuf field <code>repeated string compliant_but_disallowed_services = 24 [(.google.api.field_behavior) = OUTPUT_ONLY];</code>
@return \Google\Protobuf\Internal\RepeatedField | getCompliantButDisallowedServices | php | googleapis/google-cloud-php | AssuredWorkloads/src/V1beta1/Workload.php | https://github.com/googleapis/google-cloud-php/blob/master/AssuredWorkloads/src/V1beta1/Workload.php | Apache-2.0 |
public function setCompliantButDisallowedServices($var)
{
$arr = GPBUtil::checkRepeatedField($var, \Google\Protobuf\Internal\GPBType::STRING);
$this->compliant_but_disallowed_services = $arr;
return $this;
} | Output only. Urls for services which are compliant for this Assured Workload, but which
are currently disallowed by the ResourceUsageRestriction org policy.
Invoke RestrictAllowedResources endpoint to allow your project developers
to use these services in their environment."
Generated from protobuf field <code>repeated string compliant_but_disallowed_services = 24 [(.google.api.field_behavior) = OUTPUT_ONLY];</code>
@param array<string>|\Google\Protobuf\Internal\RepeatedField $var
@return $this | setCompliantButDisallowedServices | php | googleapis/google-cloud-php | AssuredWorkloads/src/V1beta1/Workload.php | https://github.com/googleapis/google-cloud-php/blob/master/AssuredWorkloads/src/V1beta1/Workload.php | Apache-2.0 |
public function getProgressPercent()
{
return $this->progress_percent;
} | Output only. The estimated progress of the operation in percentage [0,
100]. The value -1 means the progress is unknown.
Generated from protobuf field <code>int32 progress_percent = 6 [(.google.api.field_behavior) = OUTPUT_ONLY];</code>
@return int | getProgressPercent | php | googleapis/google-cloud-php | StorageControl/src/V2/CommonLongRunningOperationMetadata.php | https://github.com/googleapis/google-cloud-php/blob/master/StorageControl/src/V2/CommonLongRunningOperationMetadata.php | Apache-2.0 |
public function setProgressPercent($var)
{
GPBUtil::checkInt32($var);
$this->progress_percent = $var;
return $this;
} | Output only. The estimated progress of the operation in percentage [0,
100]. The value -1 means the progress is unknown.
Generated from protobuf field <code>int32 progress_percent = 6 [(.google.api.field_behavior) = OUTPUT_ONLY];</code>
@param int $var
@return $this | setProgressPercent | php | googleapis/google-cloud-php | StorageControl/src/V2/CommonLongRunningOperationMetadata.php | https://github.com/googleapis/google-cloud-php/blob/master/StorageControl/src/V2/CommonLongRunningOperationMetadata.php | Apache-2.0 |
public function setText($var)
{
GPBUtil::checkMessage($var, \Google\Cloud\Language\V1\TextSpan::class);
$this->text = $var;
return $this;
} | The mention text.
Generated from protobuf field <code>.google.cloud.language.v1.TextSpan text = 1;</code>
@param \Google\Cloud\Language\V1\TextSpan $var
@return $this | setText | php | googleapis/google-cloud-php | Language/src/V1/EntityMention.php | https://github.com/googleapis/google-cloud-php/blob/master/Language/src/V1/EntityMention.php | Apache-2.0 |
public function setType($var)
{
GPBUtil::checkEnum($var, \Google\Cloud\Language\V1\EntityMention\Type::class);
$this->type = $var;
return $this;
} | The type of the entity mention.
Generated from protobuf field <code>.google.cloud.language.v1.EntityMention.Type type = 2;</code>
@param int $var
@return $this | setType | php | googleapis/google-cloud-php | Language/src/V1/EntityMention.php | https://github.com/googleapis/google-cloud-php/blob/master/Language/src/V1/EntityMention.php | Apache-2.0 |
public function setSentiment($var)
{
GPBUtil::checkMessage($var, \Google\Cloud\Language\V1\Sentiment::class);
$this->sentiment = $var;
return $this;
} | For calls to [AnalyzeEntitySentiment][] or if
[AnnotateTextRequest.Features.extract_entity_sentiment][google.cloud.language.v1.AnnotateTextRequest.Features.extract_entity_sentiment]
is set to true, this field will contain the sentiment expressed for this
mention of the entity in the provided document.
Generated from protobuf field <code>.google.cloud.language.v1.Sentiment sentiment = 3;</code>
@param \Google\Cloud\Language\V1\Sentiment $var
@return $this | setSentiment | php | googleapis/google-cloud-php | Language/src/V1/EntityMention.php | https://github.com/googleapis/google-cloud-php/blob/master/Language/src/V1/EntityMention.php | Apache-2.0 |
public function getRolloutRestriction()
{
return $this->readOneof(2);
} | Optional. Rollout restrictions.
Generated from protobuf field <code>.google.cloud.deploy.v1.RolloutRestriction rollout_restriction = 2 [(.google.api.field_behavior) = OPTIONAL];</code>
@return \Google\Cloud\Deploy\V1\RolloutRestriction|null | getRolloutRestriction | php | googleapis/google-cloud-php | Deploy/src/V1/PolicyRule.php | https://github.com/googleapis/google-cloud-php/blob/master/Deploy/src/V1/PolicyRule.php | Apache-2.0 |
public function setRolloutRestriction($var)
{
GPBUtil::checkMessage($var, \Google\Cloud\Deploy\V1\RolloutRestriction::class);
$this->writeOneof(2, $var);
return $this;
} | Optional. Rollout restrictions.
Generated from protobuf field <code>.google.cloud.deploy.v1.RolloutRestriction rollout_restriction = 2 [(.google.api.field_behavior) = OPTIONAL];</code>
@param \Google\Cloud\Deploy\V1\RolloutRestriction $var
@return $this | setRolloutRestriction | php | googleapis/google-cloud-php | Deploy/src/V1/PolicyRule.php | https://github.com/googleapis/google-cloud-php/blob/master/Deploy/src/V1/PolicyRule.php | Apache-2.0 |
public function getAccessLevelFormat()
{
return $this->access_level_format;
} | Whether to return `BasicLevels` in the Cloud Common Expression language, as
`CustomLevels`, rather than as `BasicLevels`. Defaults to returning
`AccessLevels` in the format they were defined.
Generated from protobuf field <code>.google.identity.accesscontextmanager.v1.LevelFormat access_level_format = 4;</code>
@return int | getAccessLevelFormat | php | googleapis/google-cloud-php | AccessContextManager/src/V1/ListAccessLevelsRequest.php | https://github.com/googleapis/google-cloud-php/blob/master/AccessContextManager/src/V1/ListAccessLevelsRequest.php | Apache-2.0 |
public function setAccessLevelFormat($var)
{
GPBUtil::checkEnum($var, \Google\Identity\AccessContextManager\V1\LevelFormat::class);
$this->access_level_format = $var;
return $this;
} | Whether to return `BasicLevels` in the Cloud Common Expression language, as
`CustomLevels`, rather than as `BasicLevels`. Defaults to returning
`AccessLevels` in the format they were defined.
Generated from protobuf field <code>.google.identity.accesscontextmanager.v1.LevelFormat access_level_format = 4;</code>
@param int $var
@return $this | setAccessLevelFormat | php | googleapis/google-cloud-php | AccessContextManager/src/V1/ListAccessLevelsRequest.php | https://github.com/googleapis/google-cloud-php/blob/master/AccessContextManager/src/V1/ListAccessLevelsRequest.php | Apache-2.0 |
public function setValue($var)
{
GPBUtil::checkMessage($var, \Google\Cloud\AIPlatform\V1\FeatureValue::class);
$this->writeOneof(1, $var);
return $this;
} | Feature value if a single value is requested.
Generated from protobuf field <code>.google.cloud.aiplatform.v1.FeatureValue value = 1;</code>
@param \Google\Cloud\AIPlatform\V1\FeatureValue $var
@return $this | setValue | php | googleapis/google-cloud-php | AiPlatform/src/V1/ReadFeatureValuesResponse/EntityView/Data.php | https://github.com/googleapis/google-cloud-php/blob/master/AiPlatform/src/V1/ReadFeatureValuesResponse/EntityView/Data.php | Apache-2.0 |
public function setValues($var)
{
GPBUtil::checkMessage($var, \Google\Cloud\AIPlatform\V1\FeatureValueList::class);
$this->writeOneof(2, $var);
return $this;
} | Feature values list if values, successive in time, are requested.
If the requested number of values is greater than the number of
existing Feature values, nonexistent values are omitted instead of
being returned as empty.
Generated from protobuf field <code>.google.cloud.aiplatform.v1.FeatureValueList values = 2;</code>
@param \Google\Cloud\AIPlatform\V1\FeatureValueList $var
@return $this | setValues | php | googleapis/google-cloud-php | AiPlatform/src/V1/ReadFeatureValuesResponse/EntityView/Data.php | https://github.com/googleapis/google-cloud-php/blob/master/AiPlatform/src/V1/ReadFeatureValuesResponse/EntityView/Data.php | Apache-2.0 |
public function setView($var)
{
GPBUtil::checkMessage($var, \Google\Cloud\ContactCenterInsights\V1\View::class);
$this->view = $var;
return $this;
} | Required. The view resource to create.
Generated from protobuf field <code>.google.cloud.contactcenterinsights.v1.View view = 2 [(.google.api.field_behavior) = REQUIRED];</code>
@param \Google\Cloud\ContactCenterInsights\V1\View $var
@return $this | setView | php | googleapis/google-cloud-php | ContactCenterInsights/src/V1/CreateViewRequest.php | https://github.com/googleapis/google-cloud-php/blob/master/ContactCenterInsights/src/V1/CreateViewRequest.php | Apache-2.0 |
public function getWorkflowId()
{
return $this->workflow_id;
} | Required. The ID of the workflow to be created. It has to fulfill the
following requirements:
* Must contain only letters, numbers, underscores and hyphens.
* Must start with a letter.
* Must be between 1-64 characters.
* Must end with a number or a letter.
* Must be unique within the customer project and location.
Generated from protobuf field <code>string workflow_id = 3 [(.google.api.field_behavior) = REQUIRED];</code>
@return string | getWorkflowId | php | googleapis/google-cloud-php | Workflows/src/V1/CreateWorkflowRequest.php | https://github.com/googleapis/google-cloud-php/blob/master/Workflows/src/V1/CreateWorkflowRequest.php | Apache-2.0 |
public function setWorkflowId($var)
{
GPBUtil::checkString($var, True);
$this->workflow_id = $var;
return $this;
} | Required. The ID of the workflow to be created. It has to fulfill the
following requirements:
* Must contain only letters, numbers, underscores and hyphens.
* Must start with a letter.
* Must be between 1-64 characters.
* Must end with a number or a letter.
* Must be unique within the customer project and location.
Generated from protobuf field <code>string workflow_id = 3 [(.google.api.field_behavior) = REQUIRED];</code>
@param string $var
@return $this | setWorkflowId | php | googleapis/google-cloud-php | Workflows/src/V1/CreateWorkflowRequest.php | https://github.com/googleapis/google-cloud-php/blob/master/Workflows/src/V1/CreateWorkflowRequest.php | Apache-2.0 |
public function getClusterUuid()
{
return $this->cluster_uuid;
} | Optional. Specifying the `cluster_uuid` means the RPC will fail
(with error NOT_FOUND) if a cluster with the specified UUID does not exist.
Generated from protobuf field <code>string cluster_uuid = 4 [(.google.api.field_behavior) = OPTIONAL];</code>
@return string | getClusterUuid | php | googleapis/google-cloud-php | Dataproc/src/V1/StartClusterRequest.php | https://github.com/googleapis/google-cloud-php/blob/master/Dataproc/src/V1/StartClusterRequest.php | Apache-2.0 |
public function setClusterUuid($var)
{
GPBUtil::checkString($var, True);
$this->cluster_uuid = $var;
return $this;
} | Optional. Specifying the `cluster_uuid` means the RPC will fail
(with error NOT_FOUND) if a cluster with the specified UUID does not exist.
Generated from protobuf field <code>string cluster_uuid = 4 [(.google.api.field_behavior) = OPTIONAL];</code>
@param string $var
@return $this | setClusterUuid | php | googleapis/google-cloud-php | Dataproc/src/V1/StartClusterRequest.php | https://github.com/googleapis/google-cloud-php/blob/master/Dataproc/src/V1/StartClusterRequest.php | Apache-2.0 |
public function getBigQueryDatasetName()
{
return $this->big_query_dataset_name;
} | Output only. Name of the associated BigQuery dataset.
Generated from protobuf field <code>string big_query_dataset_name = 4 [(.google.api.field_behavior) = OUTPUT_ONLY];</code>
@return string | getBigQueryDatasetName | php | googleapis/google-cloud-php | AiPlatform/src/V1/DatasetVersion.php | https://github.com/googleapis/google-cloud-php/blob/master/AiPlatform/src/V1/DatasetVersion.php | Apache-2.0 |
public function setBigQueryDatasetName($var)
{
GPBUtil::checkString($var, True);
$this->big_query_dataset_name = $var;
return $this;
} | Output only. Name of the associated BigQuery dataset.
Generated from protobuf field <code>string big_query_dataset_name = 4 [(.google.api.field_behavior) = OUTPUT_ONLY];</code>
@param string $var
@return $this | setBigQueryDatasetName | php | googleapis/google-cloud-php | AiPlatform/src/V1/DatasetVersion.php | https://github.com/googleapis/google-cloud-php/blob/master/AiPlatform/src/V1/DatasetVersion.php | Apache-2.0 |
public function getModelReference()
{
return $this->model_reference;
} | Output only. Reference to the public base model last used by the dataset
version. Only set for prompt dataset versions.
Generated from protobuf field <code>string model_reference = 9 [(.google.api.field_behavior) = OUTPUT_ONLY];</code>
@return string | getModelReference | php | googleapis/google-cloud-php | AiPlatform/src/V1/DatasetVersion.php | https://github.com/googleapis/google-cloud-php/blob/master/AiPlatform/src/V1/DatasetVersion.php | Apache-2.0 |
public function setModelReference($var)
{
GPBUtil::checkString($var, True);
$this->model_reference = $var;
return $this;
} | Output only. Reference to the public base model last used by the dataset
version. Only set for prompt dataset versions.
Generated from protobuf field <code>string model_reference = 9 [(.google.api.field_behavior) = OUTPUT_ONLY];</code>
@param string $var
@return $this | setModelReference | php | googleapis/google-cloud-php | AiPlatform/src/V1/DatasetVersion.php | https://github.com/googleapis/google-cloud-php/blob/master/AiPlatform/src/V1/DatasetVersion.php | Apache-2.0 |
public function setUserEvent($var)
{
GPBUtil::checkString($var, True);
$this->user_event = $var;
return $this;
} | Required. URL encoded UserEvent proto with a length limit of 2,000,000
characters.
Generated from protobuf field <code>string user_event = 2 [(.google.api.field_behavior) = REQUIRED];</code>
@param string $var
@return $this | setUserEvent | 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 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 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 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 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 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 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 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 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 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 |
public function setAllowLargeDeadlineDespiteInterruptionRisk($var)
{
GPBUtil::checkBool($var);
$this->allow_large_deadline_despite_interruption_risk = $var;
return $this;
} | 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>
@param bool $var
@return $this | setAllowLargeDeadlineDespiteInterruptionRisk | 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 getUseGeodesicDistances()
{
return $this->use_geodesic_distances;
} | If true, travel distances will be computed using geodesic distances instead
of Google Maps distances, and travel times will be computed using geodesic
distances with a speed defined by `geodesic_meters_per_second`.
Generated from protobuf field <code>bool use_geodesic_distances = 15;</code>
@return bool | getUseGeodesicDistances | 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 setUseGeodesicDistances($var)
{
GPBUtil::checkBool($var);
$this->use_geodesic_distances = $var;
return $this;
} | If true, travel distances will be computed using geodesic distances instead
of Google Maps distances, and travel times will be computed using geodesic
distances with a speed defined by `geodesic_meters_per_second`.
Generated from protobuf field <code>bool use_geodesic_distances = 15;</code>
@param bool $var
@return $this | setUseGeodesicDistances | 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 getGeodesicMetersPerSecond()
{
return isset($this->geodesic_meters_per_second) ? $this->geodesic_meters_per_second : 0.0;
} | When `use_geodesic_distances` is true, this field must be set and defines
the speed applied to compute travel times. Its value must be at least 1.0
meters/seconds.
Generated from protobuf field <code>optional double geodesic_meters_per_second = 16;</code>
@return float | getGeodesicMetersPerSecond | 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 setGeodesicMetersPerSecond($var)
{
GPBUtil::checkDouble($var);
$this->geodesic_meters_per_second = $var;
return $this;
} | When `use_geodesic_distances` is true, this field must be set and defines
the speed applied to compute travel times. Its value must be at least 1.0
meters/seconds.
Generated from protobuf field <code>optional double geodesic_meters_per_second = 16;</code>
@param float $var
@return $this | setGeodesicMetersPerSecond | 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 getMaxValidationErrors()
{
return isset($this->max_validation_errors) ? $this->max_validation_errors : 0;
} | Truncates the number of validation errors returned. These errors are
typically attached to an INVALID_ARGUMENT error payload as a BadRequest
error detail (https://cloud.google.com/apis/design/errors#error_details),
unless solving_mode=VALIDATE_ONLY: see the
[OptimizeToursResponse.validation_errors][google.maps.routeoptimization.v1.OptimizeToursResponse.validation_errors]
field.
This defaults to 100 and is capped at 10,000.
Generated from protobuf field <code>optional int32 max_validation_errors = 5;</code>
@return int | getMaxValidationErrors | 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 setMaxValidationErrors($var)
{
GPBUtil::checkInt32($var);
$this->max_validation_errors = $var;
return $this;
} | Truncates the number of validation errors returned. These errors are
typically attached to an INVALID_ARGUMENT error payload as a BadRequest
error detail (https://cloud.google.com/apis/design/errors#error_details),
unless solving_mode=VALIDATE_ONLY: see the
[OptimizeToursResponse.validation_errors][google.maps.routeoptimization.v1.OptimizeToursResponse.validation_errors]
field.
This defaults to 100 and is capped at 10,000.
Generated from protobuf field <code>optional int32 max_validation_errors = 5;</code>
@param int $var
@return $this | setMaxValidationErrors | 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 getBusinessIdentity()
{
return $this->business_identity;
} | Required. The new version of the business identity.
Generated from protobuf field <code>.google.shopping.merchant.accounts.v1beta.BusinessIdentity business_identity = 1 [(.google.api.field_behavior) = REQUIRED];</code>
@return \Google\Shopping\Merchant\Accounts\V1beta\BusinessIdentity|null | getBusinessIdentity | php | googleapis/google-cloud-php | ShoppingMerchantAccounts/src/V1beta/UpdateBusinessIdentityRequest.php | https://github.com/googleapis/google-cloud-php/blob/master/ShoppingMerchantAccounts/src/V1beta/UpdateBusinessIdentityRequest.php | Apache-2.0 |
public function setBusinessIdentity($var)
{
GPBUtil::checkMessage($var, \Google\Shopping\Merchant\Accounts\V1beta\BusinessIdentity::class);
$this->business_identity = $var;
return $this;
} | Required. The new version of the business identity.
Generated from protobuf field <code>.google.shopping.merchant.accounts.v1beta.BusinessIdentity business_identity = 1 [(.google.api.field_behavior) = REQUIRED];</code>
@param \Google\Shopping\Merchant\Accounts\V1beta\BusinessIdentity $var
@return $this | setBusinessIdentity | php | googleapis/google-cloud-php | ShoppingMerchantAccounts/src/V1beta/UpdateBusinessIdentityRequest.php | https://github.com/googleapis/google-cloud-php/blob/master/ShoppingMerchantAccounts/src/V1beta/UpdateBusinessIdentityRequest.php | Apache-2.0 |
public function getFilteringAttributes()
{
return $this->filtering_attributes;
} | Output only. Filtering attributes for the event type.
Generated from protobuf field <code>repeated .google.cloud.eventarc.v1.FilteringAttribute filtering_attributes = 3 [(.google.api.field_behavior) = OUTPUT_ONLY];</code>
@return \Google\Protobuf\Internal\RepeatedField | getFilteringAttributes | php | googleapis/google-cloud-php | Eventarc/src/V1/EventType.php | https://github.com/googleapis/google-cloud-php/blob/master/Eventarc/src/V1/EventType.php | Apache-2.0 |
Subsets and Splits
No community queries yet
The top public SQL queries from the community will appear here once available.