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 setCustomDimensionKeyIds($var)
{
$arr = GPBUtil::checkRepeatedField($var, \Google\Protobuf\Internal\GPBType::INT64);
$this->custom_dimension_key_ids = $arr;
return $this;
} | Optional. Custom Dimension keys that represent CUSTOM_DIMENSION_*
dimensions. The index of this repeated field corresponds to the index on
each dimension. For example, custom_dimension_key_ids[0] describes
CUSTOM_DIMENSION_0_VALUE_ID and CUSTOM_DIMENSION_0_VALUE.
Generated from protobuf field <code>repeated int64 custom_dimension_key_ids = 7 [(.google.api.field_behavior) = OPTIONAL];</code>
@param array<int>|array<string>|\Google\Protobuf\Internal\RepeatedField $var
@return $this | setCustomDimensionKeyIds | php | googleapis/google-cloud-php | AdsAdManager/src/V1/ReportDefinition.php | https://github.com/googleapis/google-cloud-php/blob/master/AdsAdManager/src/V1/ReportDefinition.php | Apache-2.0 |
public function getLineItemCustomFieldIds()
{
return $this->line_item_custom_field_ids;
} | Optional. Custom field IDs that represent LINE_ITEM_CUSTOM_FIELD_*
dimensions. The index of this repeated field corresponds to the index on
each dimension. For example, line_item_custom_field_ids[0] describes
LINE_ITEM_CUSTOM_FIELD_0_OPTION_ID and LINE_ITEM_CUSTOM_FIELD_0_VALUE.
Generated from protobuf field <code>repeated int64 line_item_custom_field_ids = 11 [(.google.api.field_behavior) = OPTIONAL];</code>
@return \Google\Protobuf\Internal\RepeatedField | getLineItemCustomFieldIds | php | googleapis/google-cloud-php | AdsAdManager/src/V1/ReportDefinition.php | https://github.com/googleapis/google-cloud-php/blob/master/AdsAdManager/src/V1/ReportDefinition.php | Apache-2.0 |
public function setLineItemCustomFieldIds($var)
{
$arr = GPBUtil::checkRepeatedField($var, \Google\Protobuf\Internal\GPBType::INT64);
$this->line_item_custom_field_ids = $arr;
return $this;
} | Optional. Custom field IDs that represent LINE_ITEM_CUSTOM_FIELD_*
dimensions. The index of this repeated field corresponds to the index on
each dimension. For example, line_item_custom_field_ids[0] describes
LINE_ITEM_CUSTOM_FIELD_0_OPTION_ID and LINE_ITEM_CUSTOM_FIELD_0_VALUE.
Generated from protobuf field <code>repeated int64 line_item_custom_field_ids = 11 [(.google.api.field_behavior) = OPTIONAL];</code>
@param array<int>|array<string>|\Google\Protobuf\Internal\RepeatedField $var
@return $this | setLineItemCustomFieldIds | php | googleapis/google-cloud-php | AdsAdManager/src/V1/ReportDefinition.php | https://github.com/googleapis/google-cloud-php/blob/master/AdsAdManager/src/V1/ReportDefinition.php | Apache-2.0 |
public function getOrderCustomFieldIds()
{
return $this->order_custom_field_ids;
} | Optional. Custom field IDs that represent ORDER_CUSTOM_FIELD_*
dimensions. The index of this repeated field corresponds to the index on
each dimension. For example, order_custom_field_ids[0] describes
ORDER_CUSTOM_FIELD_0_OPTION_ID and ORDER_CUSTOM_FIELD_0_VALUE.
Generated from protobuf field <code>repeated int64 order_custom_field_ids = 12 [(.google.api.field_behavior) = OPTIONAL];</code>
@return \Google\Protobuf\Internal\RepeatedField | getOrderCustomFieldIds | php | googleapis/google-cloud-php | AdsAdManager/src/V1/ReportDefinition.php | https://github.com/googleapis/google-cloud-php/blob/master/AdsAdManager/src/V1/ReportDefinition.php | Apache-2.0 |
public function setOrderCustomFieldIds($var)
{
$arr = GPBUtil::checkRepeatedField($var, \Google\Protobuf\Internal\GPBType::INT64);
$this->order_custom_field_ids = $arr;
return $this;
} | Optional. Custom field IDs that represent ORDER_CUSTOM_FIELD_*
dimensions. The index of this repeated field corresponds to the index on
each dimension. For example, order_custom_field_ids[0] describes
ORDER_CUSTOM_FIELD_0_OPTION_ID and ORDER_CUSTOM_FIELD_0_VALUE.
Generated from protobuf field <code>repeated int64 order_custom_field_ids = 12 [(.google.api.field_behavior) = OPTIONAL];</code>
@param array<int>|array<string>|\Google\Protobuf\Internal\RepeatedField $var
@return $this | setOrderCustomFieldIds | php | googleapis/google-cloud-php | AdsAdManager/src/V1/ReportDefinition.php | https://github.com/googleapis/google-cloud-php/blob/master/AdsAdManager/src/V1/ReportDefinition.php | Apache-2.0 |
public function getCreativeCustomFieldIds()
{
return $this->creative_custom_field_ids;
} | Optional. Custom field IDs that represent CREATIVE_CUSTOM_FIELD_*
dimensions. The index of this repeated field corresponds to the index on
each dimension. For example, creative_custom_field_ids[0] describes
CREATIVE_CUSTOM_FIELD_0_OPTION_ID and CREATIVE_CUSTOM_FIELD_0_VALUE.
Generated from protobuf field <code>repeated int64 creative_custom_field_ids = 13 [(.google.api.field_behavior) = OPTIONAL];</code>
@return \Google\Protobuf\Internal\RepeatedField | getCreativeCustomFieldIds | php | googleapis/google-cloud-php | AdsAdManager/src/V1/ReportDefinition.php | https://github.com/googleapis/google-cloud-php/blob/master/AdsAdManager/src/V1/ReportDefinition.php | Apache-2.0 |
public function setCreativeCustomFieldIds($var)
{
$arr = GPBUtil::checkRepeatedField($var, \Google\Protobuf\Internal\GPBType::INT64);
$this->creative_custom_field_ids = $arr;
return $this;
} | Optional. Custom field IDs that represent CREATIVE_CUSTOM_FIELD_*
dimensions. The index of this repeated field corresponds to the index on
each dimension. For example, creative_custom_field_ids[0] describes
CREATIVE_CUSTOM_FIELD_0_OPTION_ID and CREATIVE_CUSTOM_FIELD_0_VALUE.
Generated from protobuf field <code>repeated int64 creative_custom_field_ids = 13 [(.google.api.field_behavior) = OPTIONAL];</code>
@param array<int>|array<string>|\Google\Protobuf\Internal\RepeatedField $var
@return $this | setCreativeCustomFieldIds | php | googleapis/google-cloud-php | AdsAdManager/src/V1/ReportDefinition.php | https://github.com/googleapis/google-cloud-php/blob/master/AdsAdManager/src/V1/ReportDefinition.php | Apache-2.0 |
public function getReportType()
{
return $this->report_type;
} | Required. The type of this report.
Generated from protobuf field <code>.google.ads.admanager.v1.Report.ReportType report_type = 8 [(.google.api.field_behavior) = REQUIRED];</code>
@return int | getReportType | php | googleapis/google-cloud-php | AdsAdManager/src/V1/ReportDefinition.php | https://github.com/googleapis/google-cloud-php/blob/master/AdsAdManager/src/V1/ReportDefinition.php | Apache-2.0 |
public function setReportType($var)
{
GPBUtil::checkEnum($var, \Google\Ads\AdManager\V1\Report\ReportType::class);
$this->report_type = $var;
return $this;
} | Required. The type of this report.
Generated from protobuf field <code>.google.ads.admanager.v1.Report.ReportType report_type = 8 [(.google.api.field_behavior) = REQUIRED];</code>
@param int $var
@return $this | setReportType | php | googleapis/google-cloud-php | AdsAdManager/src/V1/ReportDefinition.php | https://github.com/googleapis/google-cloud-php/blob/master/AdsAdManager/src/V1/ReportDefinition.php | Apache-2.0 |
public function getTimePeriodColumn()
{
return $this->time_period_column;
} | Optional. Include a time period column to introduce comparison columns in
the report for each generated period. For example, set to "QUARTERS" here
to have a column for each quarter present in the primary date range. If
"PREVIOUS PERIOD" is specified in comparison_date_range, then each quarter
column will also include comparison values for its relative previous
quarter.
Generated from protobuf field <code>.google.ads.admanager.v1.Report.TimePeriodColumn time_period_column = 10 [(.google.api.field_behavior) = OPTIONAL];</code>
@return int | getTimePeriodColumn | php | googleapis/google-cloud-php | AdsAdManager/src/V1/ReportDefinition.php | https://github.com/googleapis/google-cloud-php/blob/master/AdsAdManager/src/V1/ReportDefinition.php | Apache-2.0 |
public function setTimePeriodColumn($var)
{
GPBUtil::checkEnum($var, \Google\Ads\AdManager\V1\Report\TimePeriodColumn::class);
$this->time_period_column = $var;
return $this;
} | Optional. Include a time period column to introduce comparison columns in
the report for each generated period. For example, set to "QUARTERS" here
to have a column for each quarter present in the primary date range. If
"PREVIOUS PERIOD" is specified in comparison_date_range, then each quarter
column will also include comparison values for its relative previous
quarter.
Generated from protobuf field <code>.google.ads.admanager.v1.Report.TimePeriodColumn time_period_column = 10 [(.google.api.field_behavior) = OPTIONAL];</code>
@param int $var
@return $this | setTimePeriodColumn | php | googleapis/google-cloud-php | AdsAdManager/src/V1/ReportDefinition.php | https://github.com/googleapis/google-cloud-php/blob/master/AdsAdManager/src/V1/ReportDefinition.php | Apache-2.0 |
public function getFlags()
{
return $this->flags;
} | Optional. List of flags for this report. Used to flag rows in a result set
based on a set of defined filters.
Generated from protobuf field <code>repeated .google.ads.admanager.v1.Report.Flag flags = 14 [(.google.api.field_behavior) = OPTIONAL];</code>
@return \Google\Protobuf\Internal\RepeatedField | getFlags | php | googleapis/google-cloud-php | AdsAdManager/src/V1/ReportDefinition.php | https://github.com/googleapis/google-cloud-php/blob/master/AdsAdManager/src/V1/ReportDefinition.php | Apache-2.0 |
public function setFlags($var)
{
$arr = GPBUtil::checkRepeatedField($var, \Google\Protobuf\Internal\GPBType::MESSAGE, \Google\Ads\AdManager\V1\Report\Flag::class);
$this->flags = $arr;
return $this;
} | Optional. List of flags for this report. Used to flag rows in a result set
based on a set of defined filters.
Generated from protobuf field <code>repeated .google.ads.admanager.v1.Report.Flag flags = 14 [(.google.api.field_behavior) = OPTIONAL];</code>
@param array<\Google\Ads\AdManager\V1\Report\Flag>|\Google\Protobuf\Internal\RepeatedField $var
@return $this | setFlags | php | googleapis/google-cloud-php | AdsAdManager/src/V1/ReportDefinition.php | https://github.com/googleapis/google-cloud-php/blob/master/AdsAdManager/src/V1/ReportDefinition.php | Apache-2.0 |
public function getSorts()
{
return $this->sorts;
} | Optional. Default sorts to apply to this report.
Generated from protobuf field <code>repeated .google.ads.admanager.v1.Report.Sort sorts = 15 [(.google.api.field_behavior) = OPTIONAL];</code>
@return \Google\Protobuf\Internal\RepeatedField | getSorts | php | googleapis/google-cloud-php | AdsAdManager/src/V1/ReportDefinition.php | https://github.com/googleapis/google-cloud-php/blob/master/AdsAdManager/src/V1/ReportDefinition.php | Apache-2.0 |
public function setSorts($var)
{
$arr = GPBUtil::checkRepeatedField($var, \Google\Protobuf\Internal\GPBType::MESSAGE, \Google\Ads\AdManager\V1\Report\Sort::class);
$this->sorts = $arr;
return $this;
} | Optional. Default sorts to apply to this report.
Generated from protobuf field <code>repeated .google.ads.admanager.v1.Report.Sort sorts = 15 [(.google.api.field_behavior) = OPTIONAL];</code>
@param array<\Google\Ads\AdManager\V1\Report\Sort>|\Google\Protobuf\Internal\RepeatedField $var
@return $this | setSorts | php | googleapis/google-cloud-php | AdsAdManager/src/V1/ReportDefinition.php | https://github.com/googleapis/google-cloud-php/blob/master/AdsAdManager/src/V1/ReportDefinition.php | Apache-2.0 |
public function getResourcePolicies()
{
return $this->resource_policies;
} | Full or relative path to the resource policy to be added to this disk. You can only specify one resource policy.
Generated from protobuf field <code>repeated string resource_policies = 22220385;</code>
@return \Google\Protobuf\Internal\RepeatedField | getResourcePolicies | php | googleapis/google-cloud-php | Compute/src/V1/DisksAddResourcePoliciesRequest.php | https://github.com/googleapis/google-cloud-php/blob/master/Compute/src/V1/DisksAddResourcePoliciesRequest.php | Apache-2.0 |
public function setResourcePolicies($var)
{
$arr = GPBUtil::checkRepeatedField($var, \Google\Protobuf\Internal\GPBType::STRING);
$this->resource_policies = $arr;
return $this;
} | Full or relative path to the resource policy to be added to this disk. You can only specify one resource policy.
Generated from protobuf field <code>repeated string resource_policies = 22220385;</code>
@param array<string>|\Google\Protobuf\Internal\RepeatedField $var
@return $this | setResourcePolicies | php | googleapis/google-cloud-php | Compute/src/V1/DisksAddResourcePoliciesRequest.php | https://github.com/googleapis/google-cloud-php/blob/master/Compute/src/V1/DisksAddResourcePoliciesRequest.php | Apache-2.0 |
public function getSubnetIp()
{
return $this->subnet_ip;
} | Optional. IP address of the subnet.
Generated from protobuf field <code>string subnet_ip = 1 [(.google.api.field_behavior) = OPTIONAL];</code>
@return string | getSubnetIp | php | googleapis/google-cloud-php | NetApp/src/V1/HybridPeeringDetails.php | https://github.com/googleapis/google-cloud-php/blob/master/NetApp/src/V1/HybridPeeringDetails.php | Apache-2.0 |
public function setSubnetIp($var)
{
GPBUtil::checkString($var, True);
$this->subnet_ip = $var;
return $this;
} | Optional. IP address of the subnet.
Generated from protobuf field <code>string subnet_ip = 1 [(.google.api.field_behavior) = OPTIONAL];</code>
@param string $var
@return $this | setSubnetIp | php | googleapis/google-cloud-php | NetApp/src/V1/HybridPeeringDetails.php | https://github.com/googleapis/google-cloud-php/blob/master/NetApp/src/V1/HybridPeeringDetails.php | Apache-2.0 |
public function getCommand()
{
return $this->command;
} | Optional. Copy-paste-able commands to be used on user's ONTAP to accept
peering requests.
Generated from protobuf field <code>string command = 2 [(.google.api.field_behavior) = OPTIONAL];</code>
@return string | getCommand | php | googleapis/google-cloud-php | NetApp/src/V1/HybridPeeringDetails.php | https://github.com/googleapis/google-cloud-php/blob/master/NetApp/src/V1/HybridPeeringDetails.php | Apache-2.0 |
public function setCommand($var)
{
GPBUtil::checkString($var, True);
$this->command = $var;
return $this;
} | Optional. Copy-paste-able commands to be used on user's ONTAP to accept
peering requests.
Generated from protobuf field <code>string command = 2 [(.google.api.field_behavior) = OPTIONAL];</code>
@param string $var
@return $this | setCommand | php | googleapis/google-cloud-php | NetApp/src/V1/HybridPeeringDetails.php | https://github.com/googleapis/google-cloud-php/blob/master/NetApp/src/V1/HybridPeeringDetails.php | Apache-2.0 |
public function getCommandExpiryTime()
{
return $this->command_expiry_time;
} | Optional. Expiration time for the peering command to be executed on user's
ONTAP.
Generated from protobuf field <code>.google.protobuf.Timestamp command_expiry_time = 3 [(.google.api.field_behavior) = OPTIONAL];</code>
@return \Google\Protobuf\Timestamp|null | getCommandExpiryTime | php | googleapis/google-cloud-php | NetApp/src/V1/HybridPeeringDetails.php | https://github.com/googleapis/google-cloud-php/blob/master/NetApp/src/V1/HybridPeeringDetails.php | Apache-2.0 |
public function setCommandExpiryTime($var)
{
GPBUtil::checkMessage($var, \Google\Protobuf\Timestamp::class);
$this->command_expiry_time = $var;
return $this;
} | Optional. Expiration time for the peering command to be executed on user's
ONTAP.
Generated from protobuf field <code>.google.protobuf.Timestamp command_expiry_time = 3 [(.google.api.field_behavior) = OPTIONAL];</code>
@param \Google\Protobuf\Timestamp $var
@return $this | setCommandExpiryTime | php | googleapis/google-cloud-php | NetApp/src/V1/HybridPeeringDetails.php | https://github.com/googleapis/google-cloud-php/blob/master/NetApp/src/V1/HybridPeeringDetails.php | Apache-2.0 |
public function getPassphrase()
{
return $this->passphrase;
} | Optional. Temporary passphrase generated to accept cluster peering command.
Generated from protobuf field <code>string passphrase = 4 [(.google.api.field_behavior) = OPTIONAL];</code>
@return string | getPassphrase | php | googleapis/google-cloud-php | NetApp/src/V1/HybridPeeringDetails.php | https://github.com/googleapis/google-cloud-php/blob/master/NetApp/src/V1/HybridPeeringDetails.php | Apache-2.0 |
public function setPassphrase($var)
{
GPBUtil::checkString($var, True);
$this->passphrase = $var;
return $this;
} | Optional. Temporary passphrase generated to accept cluster peering command.
Generated from protobuf field <code>string passphrase = 4 [(.google.api.field_behavior) = OPTIONAL];</code>
@param string $var
@return $this | setPassphrase | php | googleapis/google-cloud-php | NetApp/src/V1/HybridPeeringDetails.php | https://github.com/googleapis/google-cloud-php/blob/master/NetApp/src/V1/HybridPeeringDetails.php | Apache-2.0 |
public function getPeerVolumeName()
{
return $this->peer_volume_name;
} | Optional. Name of the user's local source volume to be peered with the
destination volume.
Generated from protobuf field <code>string peer_volume_name = 5 [(.google.api.field_behavior) = OPTIONAL];</code>
@return string | getPeerVolumeName | php | googleapis/google-cloud-php | NetApp/src/V1/HybridPeeringDetails.php | https://github.com/googleapis/google-cloud-php/blob/master/NetApp/src/V1/HybridPeeringDetails.php | Apache-2.0 |
public function setPeerVolumeName($var)
{
GPBUtil::checkString($var, True);
$this->peer_volume_name = $var;
return $this;
} | Optional. Name of the user's local source volume to be peered with the
destination volume.
Generated from protobuf field <code>string peer_volume_name = 5 [(.google.api.field_behavior) = OPTIONAL];</code>
@param string $var
@return $this | setPeerVolumeName | php | googleapis/google-cloud-php | NetApp/src/V1/HybridPeeringDetails.php | https://github.com/googleapis/google-cloud-php/blob/master/NetApp/src/V1/HybridPeeringDetails.php | Apache-2.0 |
public function getPeerClusterName()
{
return $this->peer_cluster_name;
} | Optional. Name of the user's local source cluster to be peered with the
destination cluster.
Generated from protobuf field <code>string peer_cluster_name = 6 [(.google.api.field_behavior) = OPTIONAL];</code>
@return string | getPeerClusterName | php | googleapis/google-cloud-php | NetApp/src/V1/HybridPeeringDetails.php | https://github.com/googleapis/google-cloud-php/blob/master/NetApp/src/V1/HybridPeeringDetails.php | Apache-2.0 |
public function setPeerClusterName($var)
{
GPBUtil::checkString($var, True);
$this->peer_cluster_name = $var;
return $this;
} | Optional. Name of the user's local source cluster to be peered with the
destination cluster.
Generated from protobuf field <code>string peer_cluster_name = 6 [(.google.api.field_behavior) = OPTIONAL];</code>
@param string $var
@return $this | setPeerClusterName | php | googleapis/google-cloud-php | NetApp/src/V1/HybridPeeringDetails.php | https://github.com/googleapis/google-cloud-php/blob/master/NetApp/src/V1/HybridPeeringDetails.php | Apache-2.0 |
public function getPeerSvmName()
{
return $this->peer_svm_name;
} | Optional. Name of the user's local source vserver svm to be peered with the
destination vserver svm.
Generated from protobuf field <code>string peer_svm_name = 7 [(.google.api.field_behavior) = OPTIONAL];</code>
@return string | getPeerSvmName | php | googleapis/google-cloud-php | NetApp/src/V1/HybridPeeringDetails.php | https://github.com/googleapis/google-cloud-php/blob/master/NetApp/src/V1/HybridPeeringDetails.php | Apache-2.0 |
public function setPeerSvmName($var)
{
GPBUtil::checkString($var, True);
$this->peer_svm_name = $var;
return $this;
} | Optional. Name of the user's local source vserver svm to be peered with the
destination vserver svm.
Generated from protobuf field <code>string peer_svm_name = 7 [(.google.api.field_behavior) = OPTIONAL];</code>
@param string $var
@return $this | setPeerSvmName | php | googleapis/google-cloud-php | NetApp/src/V1/HybridPeeringDetails.php | https://github.com/googleapis/google-cloud-php/blob/master/NetApp/src/V1/HybridPeeringDetails.php | Apache-2.0 |
public function getEnabled()
{
return $this->enabled;
} | Whether Confidential Nodes feature is enabled.
Generated from protobuf field <code>bool enabled = 1;</code>
@return bool | getEnabled | php | googleapis/google-cloud-php | Container/src/V1/ConfidentialNodes.php | https://github.com/googleapis/google-cloud-php/blob/master/Container/src/V1/ConfidentialNodes.php | Apache-2.0 |
public function setEnabled($var)
{
GPBUtil::checkBool($var);
$this->enabled = $var;
return $this;
} | Whether Confidential Nodes feature is enabled.
Generated from protobuf field <code>bool enabled = 1;</code>
@param bool $var
@return $this | setEnabled | php | googleapis/google-cloud-php | Container/src/V1/ConfidentialNodes.php | https://github.com/googleapis/google-cloud-php/blob/master/Container/src/V1/ConfidentialNodes.php | Apache-2.0 |
public function getParent()
{
return $this->parent;
} | Required. The parent location where this
[AttachedCluster][google.cloud.gkemulticloud.v1.AttachedCluster] resource
will be created.
Location names are formatted as `projects/<project-id>/locations/<region>`.
See [Resource Names](https://cloud.google.com/apis/design/resource_names)
for more details on Google Cloud resource names.
Generated from protobuf field <code>string parent = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = {</code>
@return string | getParent | php | googleapis/google-cloud-php | GkeMultiCloud/src/V1/CreateAttachedClusterRequest.php | https://github.com/googleapis/google-cloud-php/blob/master/GkeMultiCloud/src/V1/CreateAttachedClusterRequest.php | Apache-2.0 |
public function setParent($var)
{
GPBUtil::checkString($var, True);
$this->parent = $var;
return $this;
} | Required. The parent location where this
[AttachedCluster][google.cloud.gkemulticloud.v1.AttachedCluster] resource
will be created.
Location names are formatted as `projects/<project-id>/locations/<region>`.
See [Resource Names](https://cloud.google.com/apis/design/resource_names)
for more details on Google Cloud resource names.
Generated from protobuf field <code>string parent = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = {</code>
@param string $var
@return $this | setParent | php | googleapis/google-cloud-php | GkeMultiCloud/src/V1/CreateAttachedClusterRequest.php | https://github.com/googleapis/google-cloud-php/blob/master/GkeMultiCloud/src/V1/CreateAttachedClusterRequest.php | Apache-2.0 |
public function getAttachedCluster()
{
return $this->attached_cluster;
} | Required. The specification of the
[AttachedCluster][google.cloud.gkemulticloud.v1.AttachedCluster] to create.
Generated from protobuf field <code>.google.cloud.gkemulticloud.v1.AttachedCluster attached_cluster = 2 [(.google.api.field_behavior) = REQUIRED];</code>
@return \Google\Cloud\GkeMultiCloud\V1\AttachedCluster|null | getAttachedCluster | php | googleapis/google-cloud-php | GkeMultiCloud/src/V1/CreateAttachedClusterRequest.php | https://github.com/googleapis/google-cloud-php/blob/master/GkeMultiCloud/src/V1/CreateAttachedClusterRequest.php | Apache-2.0 |
public function setAttachedCluster($var)
{
GPBUtil::checkMessage($var, \Google\Cloud\GkeMultiCloud\V1\AttachedCluster::class);
$this->attached_cluster = $var;
return $this;
} | Required. The specification of the
[AttachedCluster][google.cloud.gkemulticloud.v1.AttachedCluster] to create.
Generated from protobuf field <code>.google.cloud.gkemulticloud.v1.AttachedCluster attached_cluster = 2 [(.google.api.field_behavior) = REQUIRED];</code>
@param \Google\Cloud\GkeMultiCloud\V1\AttachedCluster $var
@return $this | setAttachedCluster | php | googleapis/google-cloud-php | GkeMultiCloud/src/V1/CreateAttachedClusterRequest.php | https://github.com/googleapis/google-cloud-php/blob/master/GkeMultiCloud/src/V1/CreateAttachedClusterRequest.php | Apache-2.0 |
public function getAttachedClusterId()
{
return $this->attached_cluster_id;
} | Required. A client provided ID the resource. Must be unique within the
parent resource.
The provided ID will be part of the
[AttachedCluster][google.cloud.gkemulticloud.v1.AttachedCluster] resource
name formatted as
`projects/<project-id>/locations/<region>/attachedClusters/<cluster-id>`.
Valid characters are `/[a-z][0-9]-/`. Cannot be longer than 63 characters.
Generated from protobuf field <code>string attached_cluster_id = 3 [(.google.api.field_behavior) = REQUIRED];</code>
@return string | getAttachedClusterId | php | googleapis/google-cloud-php | GkeMultiCloud/src/V1/CreateAttachedClusterRequest.php | https://github.com/googleapis/google-cloud-php/blob/master/GkeMultiCloud/src/V1/CreateAttachedClusterRequest.php | Apache-2.0 |
public function setAttachedClusterId($var)
{
GPBUtil::checkString($var, True);
$this->attached_cluster_id = $var;
return $this;
} | Required. A client provided ID the resource. Must be unique within the
parent resource.
The provided ID will be part of the
[AttachedCluster][google.cloud.gkemulticloud.v1.AttachedCluster] resource
name formatted as
`projects/<project-id>/locations/<region>/attachedClusters/<cluster-id>`.
Valid characters are `/[a-z][0-9]-/`. Cannot be longer than 63 characters.
Generated from protobuf field <code>string attached_cluster_id = 3 [(.google.api.field_behavior) = REQUIRED];</code>
@param string $var
@return $this | setAttachedClusterId | php | googleapis/google-cloud-php | GkeMultiCloud/src/V1/CreateAttachedClusterRequest.php | https://github.com/googleapis/google-cloud-php/blob/master/GkeMultiCloud/src/V1/CreateAttachedClusterRequest.php | Apache-2.0 |
public function getValidateOnly()
{
return $this->validate_only;
} | If set, only validate the request, but do not actually create the cluster.
Generated from protobuf field <code>bool validate_only = 4;</code>
@return bool | getValidateOnly | php | googleapis/google-cloud-php | GkeMultiCloud/src/V1/CreateAttachedClusterRequest.php | https://github.com/googleapis/google-cloud-php/blob/master/GkeMultiCloud/src/V1/CreateAttachedClusterRequest.php | Apache-2.0 |
public function setValidateOnly($var)
{
GPBUtil::checkBool($var);
$this->validate_only = $var;
return $this;
} | If set, only validate the request, but do not actually create the cluster.
Generated from protobuf field <code>bool validate_only = 4;</code>
@param bool $var
@return $this | setValidateOnly | php | googleapis/google-cloud-php | GkeMultiCloud/src/V1/CreateAttachedClusterRequest.php | https://github.com/googleapis/google-cloud-php/blob/master/GkeMultiCloud/src/V1/CreateAttachedClusterRequest.php | Apache-2.0 |
public function getToken()
{
return $this->token;
} | Optional. The user response token provided by the reCAPTCHA Enterprise
client-side integration on your site.
Generated from protobuf field <code>string token = 1 [(.google.api.field_behavior) = OPTIONAL];</code>
@return string | getToken | php | googleapis/google-cloud-php | RecaptchaEnterprise/src/V1/Event.php | https://github.com/googleapis/google-cloud-php/blob/master/RecaptchaEnterprise/src/V1/Event.php | Apache-2.0 |
public function setToken($var)
{
GPBUtil::checkString($var, True);
$this->token = $var;
return $this;
} | Optional. The user response token provided by the reCAPTCHA Enterprise
client-side integration on your site.
Generated from protobuf field <code>string token = 1 [(.google.api.field_behavior) = OPTIONAL];</code>
@param string $var
@return $this | setToken | php | googleapis/google-cloud-php | RecaptchaEnterprise/src/V1/Event.php | https://github.com/googleapis/google-cloud-php/blob/master/RecaptchaEnterprise/src/V1/Event.php | Apache-2.0 |
public function getSiteKey()
{
return $this->site_key;
} | Optional. The site key that was used to invoke reCAPTCHA Enterprise on your
site and generate the token.
Generated from protobuf field <code>string site_key = 2 [(.google.api.field_behavior) = OPTIONAL];</code>
@return string | getSiteKey | php | googleapis/google-cloud-php | RecaptchaEnterprise/src/V1/Event.php | https://github.com/googleapis/google-cloud-php/blob/master/RecaptchaEnterprise/src/V1/Event.php | Apache-2.0 |
public function setSiteKey($var)
{
GPBUtil::checkString($var, True);
$this->site_key = $var;
return $this;
} | Optional. The site key that was used to invoke reCAPTCHA Enterprise on your
site and generate the token.
Generated from protobuf field <code>string site_key = 2 [(.google.api.field_behavior) = OPTIONAL];</code>
@param string $var
@return $this | setSiteKey | php | googleapis/google-cloud-php | RecaptchaEnterprise/src/V1/Event.php | https://github.com/googleapis/google-cloud-php/blob/master/RecaptchaEnterprise/src/V1/Event.php | Apache-2.0 |
public function getUserAgent()
{
return $this->user_agent;
} | Optional. The user agent present in the request from the user's device
related to this event.
Generated from protobuf field <code>string user_agent = 3 [(.google.api.field_behavior) = OPTIONAL];</code>
@return string | getUserAgent | php | googleapis/google-cloud-php | RecaptchaEnterprise/src/V1/Event.php | https://github.com/googleapis/google-cloud-php/blob/master/RecaptchaEnterprise/src/V1/Event.php | Apache-2.0 |
public function setUserAgent($var)
{
GPBUtil::checkString($var, True);
$this->user_agent = $var;
return $this;
} | Optional. The user agent present in the request from the user's device
related to this event.
Generated from protobuf field <code>string user_agent = 3 [(.google.api.field_behavior) = OPTIONAL];</code>
@param string $var
@return $this | setUserAgent | php | googleapis/google-cloud-php | RecaptchaEnterprise/src/V1/Event.php | https://github.com/googleapis/google-cloud-php/blob/master/RecaptchaEnterprise/src/V1/Event.php | Apache-2.0 |
public function getUserIpAddress()
{
return $this->user_ip_address;
} | Optional. The IP address in the request from the user's device related to
this event.
Generated from protobuf field <code>string user_ip_address = 4 [(.google.api.field_behavior) = OPTIONAL, (.google.api.field_info) = {</code>
@return string | getUserIpAddress | php | googleapis/google-cloud-php | RecaptchaEnterprise/src/V1/Event.php | https://github.com/googleapis/google-cloud-php/blob/master/RecaptchaEnterprise/src/V1/Event.php | Apache-2.0 |
public function setUserIpAddress($var)
{
GPBUtil::checkString($var, True);
$this->user_ip_address = $var;
return $this;
} | Optional. The IP address in the request from the user's device related to
this event.
Generated from protobuf field <code>string user_ip_address = 4 [(.google.api.field_behavior) = OPTIONAL, (.google.api.field_info) = {</code>
@param string $var
@return $this | setUserIpAddress | php | googleapis/google-cloud-php | RecaptchaEnterprise/src/V1/Event.php | https://github.com/googleapis/google-cloud-php/blob/master/RecaptchaEnterprise/src/V1/Event.php | Apache-2.0 |
public function getExpectedAction()
{
return $this->expected_action;
} | Optional. The expected action for this type of event. This should be the
same action provided at token generation time on client-side platforms
already integrated with recaptcha enterprise.
Generated from protobuf field <code>string expected_action = 5 [(.google.api.field_behavior) = OPTIONAL];</code>
@return string | getExpectedAction | php | googleapis/google-cloud-php | RecaptchaEnterprise/src/V1/Event.php | https://github.com/googleapis/google-cloud-php/blob/master/RecaptchaEnterprise/src/V1/Event.php | Apache-2.0 |
public function setExpectedAction($var)
{
GPBUtil::checkString($var, True);
$this->expected_action = $var;
return $this;
} | Optional. The expected action for this type of event. This should be the
same action provided at token generation time on client-side platforms
already integrated with recaptcha enterprise.
Generated from protobuf field <code>string expected_action = 5 [(.google.api.field_behavior) = OPTIONAL];</code>
@param string $var
@return $this | setExpectedAction | php | googleapis/google-cloud-php | RecaptchaEnterprise/src/V1/Event.php | https://github.com/googleapis/google-cloud-php/blob/master/RecaptchaEnterprise/src/V1/Event.php | Apache-2.0 |
public function getHashedAccountId()
{
@trigger_error('hashed_account_id is deprecated.', E_USER_DEPRECATED);
return $this->hashed_account_id;
} | Optional. Deprecated: use `user_info.account_id` instead.
Unique stable hashed user identifier for the request. The identifier must
be hashed using hmac-sha256 with stable secret.
Generated from protobuf field <code>bytes hashed_account_id = 6 [deprecated = true, (.google.api.field_behavior) = OPTIONAL];</code>
@return string
@deprecated | getHashedAccountId | php | googleapis/google-cloud-php | RecaptchaEnterprise/src/V1/Event.php | https://github.com/googleapis/google-cloud-php/blob/master/RecaptchaEnterprise/src/V1/Event.php | Apache-2.0 |
public function setHashedAccountId($var)
{
@trigger_error('hashed_account_id is deprecated.', E_USER_DEPRECATED);
GPBUtil::checkString($var, False);
$this->hashed_account_id = $var;
return $this;
} | Optional. Deprecated: use `user_info.account_id` instead.
Unique stable hashed user identifier for the request. The identifier must
be hashed using hmac-sha256 with stable secret.
Generated from protobuf field <code>bytes hashed_account_id = 6 [deprecated = true, (.google.api.field_behavior) = OPTIONAL];</code>
@param string $var
@return $this
@deprecated | setHashedAccountId | php | googleapis/google-cloud-php | RecaptchaEnterprise/src/V1/Event.php | https://github.com/googleapis/google-cloud-php/blob/master/RecaptchaEnterprise/src/V1/Event.php | Apache-2.0 |
public function getExpress()
{
return $this->express;
} | Optional. Flag for a reCAPTCHA express request for an assessment without a
token. If enabled, `site_key` must reference an Express site key.
Generated from protobuf field <code>bool express = 14 [(.google.api.field_behavior) = OPTIONAL];</code>
@return bool | getExpress | php | googleapis/google-cloud-php | RecaptchaEnterprise/src/V1/Event.php | https://github.com/googleapis/google-cloud-php/blob/master/RecaptchaEnterprise/src/V1/Event.php | Apache-2.0 |
public function setExpress($var)
{
GPBUtil::checkBool($var);
$this->express = $var;
return $this;
} | Optional. Flag for a reCAPTCHA express request for an assessment without a
token. If enabled, `site_key` must reference an Express site key.
Generated from protobuf field <code>bool express = 14 [(.google.api.field_behavior) = OPTIONAL];</code>
@param bool $var
@return $this | setExpress | php | googleapis/google-cloud-php | RecaptchaEnterprise/src/V1/Event.php | https://github.com/googleapis/google-cloud-php/blob/master/RecaptchaEnterprise/src/V1/Event.php | Apache-2.0 |
public function getRequestedUri()
{
return $this->requested_uri;
} | Optional. The URI resource the user requested that triggered an assessment.
Generated from protobuf field <code>string requested_uri = 8 [(.google.api.field_behavior) = OPTIONAL];</code>
@return string | getRequestedUri | php | googleapis/google-cloud-php | RecaptchaEnterprise/src/V1/Event.php | https://github.com/googleapis/google-cloud-php/blob/master/RecaptchaEnterprise/src/V1/Event.php | Apache-2.0 |
public function setRequestedUri($var)
{
GPBUtil::checkString($var, True);
$this->requested_uri = $var;
return $this;
} | Optional. The URI resource the user requested that triggered an assessment.
Generated from protobuf field <code>string requested_uri = 8 [(.google.api.field_behavior) = OPTIONAL];</code>
@param string $var
@return $this | setRequestedUri | php | googleapis/google-cloud-php | RecaptchaEnterprise/src/V1/Event.php | https://github.com/googleapis/google-cloud-php/blob/master/RecaptchaEnterprise/src/V1/Event.php | Apache-2.0 |
public function getWafTokenAssessment()
{
return $this->waf_token_assessment;
} | Optional. Flag for running WAF token assessment.
If enabled, the token must be specified, and have been created by a
WAF-enabled key.
Generated from protobuf field <code>bool waf_token_assessment = 9 [(.google.api.field_behavior) = OPTIONAL];</code>
@return bool | getWafTokenAssessment | php | googleapis/google-cloud-php | RecaptchaEnterprise/src/V1/Event.php | https://github.com/googleapis/google-cloud-php/blob/master/RecaptchaEnterprise/src/V1/Event.php | Apache-2.0 |
public function setWafTokenAssessment($var)
{
GPBUtil::checkBool($var);
$this->waf_token_assessment = $var;
return $this;
} | Optional. Flag for running WAF token assessment.
If enabled, the token must be specified, and have been created by a
WAF-enabled key.
Generated from protobuf field <code>bool waf_token_assessment = 9 [(.google.api.field_behavior) = OPTIONAL];</code>
@param bool $var
@return $this | setWafTokenAssessment | php | googleapis/google-cloud-php | RecaptchaEnterprise/src/V1/Event.php | https://github.com/googleapis/google-cloud-php/blob/master/RecaptchaEnterprise/src/V1/Event.php | Apache-2.0 |
public function getJa3()
{
return $this->ja3;
} | Optional. JA3 fingerprint for SSL clients. To learn how to compute this
fingerprint, please refer to https://github.com/salesforce/ja3.
Generated from protobuf field <code>string ja3 = 10 [(.google.api.field_behavior) = OPTIONAL];</code>
@return string | getJa3 | php | googleapis/google-cloud-php | RecaptchaEnterprise/src/V1/Event.php | https://github.com/googleapis/google-cloud-php/blob/master/RecaptchaEnterprise/src/V1/Event.php | Apache-2.0 |
public function setJa3($var)
{
GPBUtil::checkString($var, True);
$this->ja3 = $var;
return $this;
} | Optional. JA3 fingerprint for SSL clients. To learn how to compute this
fingerprint, please refer to https://github.com/salesforce/ja3.
Generated from protobuf field <code>string ja3 = 10 [(.google.api.field_behavior) = OPTIONAL];</code>
@param string $var
@return $this | setJa3 | php | googleapis/google-cloud-php | RecaptchaEnterprise/src/V1/Event.php | https://github.com/googleapis/google-cloud-php/blob/master/RecaptchaEnterprise/src/V1/Event.php | Apache-2.0 |
public function getJa4()
{
return $this->ja4;
} | Optional. JA4 fingerprint for SSL clients. To learn how to compute this
fingerprint, please refer to https://github.com/FoxIO-LLC/ja4.
Generated from protobuf field <code>string ja4 = 18 [(.google.api.field_behavior) = OPTIONAL];</code>
@return string | getJa4 | php | googleapis/google-cloud-php | RecaptchaEnterprise/src/V1/Event.php | https://github.com/googleapis/google-cloud-php/blob/master/RecaptchaEnterprise/src/V1/Event.php | Apache-2.0 |
public function setJa4($var)
{
GPBUtil::checkString($var, True);
$this->ja4 = $var;
return $this;
} | Optional. JA4 fingerprint for SSL clients. To learn how to compute this
fingerprint, please refer to https://github.com/FoxIO-LLC/ja4.
Generated from protobuf field <code>string ja4 = 18 [(.google.api.field_behavior) = OPTIONAL];</code>
@param string $var
@return $this | setJa4 | php | googleapis/google-cloud-php | RecaptchaEnterprise/src/V1/Event.php | https://github.com/googleapis/google-cloud-php/blob/master/RecaptchaEnterprise/src/V1/Event.php | Apache-2.0 |
public function getHeaders()
{
return $this->headers;
} | Optional. HTTP header information about the request.
Generated from protobuf field <code>repeated string headers = 11 [(.google.api.field_behavior) = OPTIONAL];</code>
@return \Google\Protobuf\Internal\RepeatedField | getHeaders | php | googleapis/google-cloud-php | RecaptchaEnterprise/src/V1/Event.php | https://github.com/googleapis/google-cloud-php/blob/master/RecaptchaEnterprise/src/V1/Event.php | Apache-2.0 |
public function setHeaders($var)
{
$arr = GPBUtil::checkRepeatedField($var, \Google\Protobuf\Internal\GPBType::STRING);
$this->headers = $arr;
return $this;
} | Optional. HTTP header information about the request.
Generated from protobuf field <code>repeated string headers = 11 [(.google.api.field_behavior) = OPTIONAL];</code>
@param array<string>|\Google\Protobuf\Internal\RepeatedField $var
@return $this | setHeaders | php | googleapis/google-cloud-php | RecaptchaEnterprise/src/V1/Event.php | https://github.com/googleapis/google-cloud-php/blob/master/RecaptchaEnterprise/src/V1/Event.php | Apache-2.0 |
public function getFirewallPolicyEvaluation()
{
return $this->firewall_policy_evaluation;
} | Optional. Flag for enabling firewall policy config assessment.
If this flag is enabled, the firewall policy is evaluated and a
suggested firewall action is returned in the response.
Generated from protobuf field <code>bool firewall_policy_evaluation = 12 [(.google.api.field_behavior) = OPTIONAL];</code>
@return bool | getFirewallPolicyEvaluation | php | googleapis/google-cloud-php | RecaptchaEnterprise/src/V1/Event.php | https://github.com/googleapis/google-cloud-php/blob/master/RecaptchaEnterprise/src/V1/Event.php | Apache-2.0 |
public function setFirewallPolicyEvaluation($var)
{
GPBUtil::checkBool($var);
$this->firewall_policy_evaluation = $var;
return $this;
} | Optional. Flag for enabling firewall policy config assessment.
If this flag is enabled, the firewall policy is evaluated and a
suggested firewall action is returned in the response.
Generated from protobuf field <code>bool firewall_policy_evaluation = 12 [(.google.api.field_behavior) = OPTIONAL];</code>
@param bool $var
@return $this | setFirewallPolicyEvaluation | php | googleapis/google-cloud-php | RecaptchaEnterprise/src/V1/Event.php | https://github.com/googleapis/google-cloud-php/blob/master/RecaptchaEnterprise/src/V1/Event.php | Apache-2.0 |
public function getTransactionData()
{
return $this->transaction_data;
} | Optional. Data describing a payment transaction to be assessed. Sending
this data enables reCAPTCHA Enterprise Fraud Prevention and the
FraudPreventionAssessment component in the response.
Generated from protobuf field <code>.google.cloud.recaptchaenterprise.v1.TransactionData transaction_data = 13 [(.google.api.field_behavior) = OPTIONAL];</code>
@return \Google\Cloud\RecaptchaEnterprise\V1\TransactionData|null | getTransactionData | php | googleapis/google-cloud-php | RecaptchaEnterprise/src/V1/Event.php | https://github.com/googleapis/google-cloud-php/blob/master/RecaptchaEnterprise/src/V1/Event.php | Apache-2.0 |
public function setTransactionData($var)
{
GPBUtil::checkMessage($var, \Google\Cloud\RecaptchaEnterprise\V1\TransactionData::class);
$this->transaction_data = $var;
return $this;
} | Optional. Data describing a payment transaction to be assessed. Sending
this data enables reCAPTCHA Enterprise Fraud Prevention and the
FraudPreventionAssessment component in the response.
Generated from protobuf field <code>.google.cloud.recaptchaenterprise.v1.TransactionData transaction_data = 13 [(.google.api.field_behavior) = OPTIONAL];</code>
@param \Google\Cloud\RecaptchaEnterprise\V1\TransactionData $var
@return $this | setTransactionData | php | googleapis/google-cloud-php | RecaptchaEnterprise/src/V1/Event.php | https://github.com/googleapis/google-cloud-php/blob/master/RecaptchaEnterprise/src/V1/Event.php | Apache-2.0 |
public function getUserInfo()
{
return $this->user_info;
} | Optional. Information about the user that generates this event, when they
can be identified. They are often identified through the use of an account
for logged-in requests or login/registration requests, or by providing user
identifiers for guest actions like checkout.
Generated from protobuf field <code>.google.cloud.recaptchaenterprise.v1.UserInfo user_info = 15 [(.google.api.field_behavior) = OPTIONAL];</code>
@return \Google\Cloud\RecaptchaEnterprise\V1\UserInfo|null | getUserInfo | php | googleapis/google-cloud-php | RecaptchaEnterprise/src/V1/Event.php | https://github.com/googleapis/google-cloud-php/blob/master/RecaptchaEnterprise/src/V1/Event.php | Apache-2.0 |
public function setUserInfo($var)
{
GPBUtil::checkMessage($var, \Google\Cloud\RecaptchaEnterprise\V1\UserInfo::class);
$this->user_info = $var;
return $this;
} | Optional. Information about the user that generates this event, when they
can be identified. They are often identified through the use of an account
for logged-in requests or login/registration requests, or by providing user
identifiers for guest actions like checkout.
Generated from protobuf field <code>.google.cloud.recaptchaenterprise.v1.UserInfo user_info = 15 [(.google.api.field_behavior) = OPTIONAL];</code>
@param \Google\Cloud\RecaptchaEnterprise\V1\UserInfo $var
@return $this | setUserInfo | php | googleapis/google-cloud-php | RecaptchaEnterprise/src/V1/Event.php | https://github.com/googleapis/google-cloud-php/blob/master/RecaptchaEnterprise/src/V1/Event.php | Apache-2.0 |
public function getFraudPrevention()
{
return $this->fraud_prevention;
} | Optional. The Fraud Prevention setting for this assessment.
Generated from protobuf field <code>.google.cloud.recaptchaenterprise.v1.Event.FraudPrevention fraud_prevention = 17 [(.google.api.field_behavior) = OPTIONAL];</code>
@return int | getFraudPrevention | php | googleapis/google-cloud-php | RecaptchaEnterprise/src/V1/Event.php | https://github.com/googleapis/google-cloud-php/blob/master/RecaptchaEnterprise/src/V1/Event.php | Apache-2.0 |
public function setFraudPrevention($var)
{
GPBUtil::checkEnum($var, \Google\Cloud\RecaptchaEnterprise\V1\Event\FraudPrevention::class);
$this->fraud_prevention = $var;
return $this;
} | Optional. The Fraud Prevention setting for this assessment.
Generated from protobuf field <code>.google.cloud.recaptchaenterprise.v1.Event.FraudPrevention fraud_prevention = 17 [(.google.api.field_behavior) = OPTIONAL];</code>
@param int $var
@return $this | setFraudPrevention | php | googleapis/google-cloud-php | RecaptchaEnterprise/src/V1/Event.php | https://github.com/googleapis/google-cloud-php/blob/master/RecaptchaEnterprise/src/V1/Event.php | Apache-2.0 |
public function getKgCO2E()
{
return $this->kg_c_o2e;
} | Carbon Footprint generated in kg of CO2 equivalent.
Chose kg_c_o2e so that the name renders correctly in camelCase (kgCO2e).
Generated from protobuf field <code>double kg_c_o2e = 1;</code>
@return float | getKgCO2E | php | googleapis/google-cloud-php | Recommender/src/V1/SustainabilityProjection.php | https://github.com/googleapis/google-cloud-php/blob/master/Recommender/src/V1/SustainabilityProjection.php | Apache-2.0 |
public function setKgCO2E($var)
{
GPBUtil::checkDouble($var);
$this->kg_c_o2e = $var;
return $this;
} | Carbon Footprint generated in kg of CO2 equivalent.
Chose kg_c_o2e so that the name renders correctly in camelCase (kgCO2e).
Generated from protobuf field <code>double kg_c_o2e = 1;</code>
@param float $var
@return $this | setKgCO2E | php | googleapis/google-cloud-php | Recommender/src/V1/SustainabilityProjection.php | https://github.com/googleapis/google-cloud-php/blob/master/Recommender/src/V1/SustainabilityProjection.php | Apache-2.0 |
public function getDuration()
{
return $this->duration;
} | Duration for which this sustainability applies.
Generated from protobuf field <code>.google.protobuf.Duration duration = 2;</code>
@return \Google\Protobuf\Duration|null | getDuration | php | googleapis/google-cloud-php | Recommender/src/V1/SustainabilityProjection.php | https://github.com/googleapis/google-cloud-php/blob/master/Recommender/src/V1/SustainabilityProjection.php | Apache-2.0 |
public function setDuration($var)
{
GPBUtil::checkMessage($var, \Google\Protobuf\Duration::class);
$this->duration = $var;
return $this;
} | Duration for which this sustainability applies.
Generated from protobuf field <code>.google.protobuf.Duration duration = 2;</code>
@param \Google\Protobuf\Duration $var
@return $this | setDuration | php | googleapis/google-cloud-php | Recommender/src/V1/SustainabilityProjection.php | https://github.com/googleapis/google-cloud-php/blob/master/Recommender/src/V1/SustainabilityProjection.php | Apache-2.0 |
public function getName()
{
return $this->name;
} | Required. The resource name of the dataScan:
`projects/{project}/locations/{location_id}/dataScans/{data_scan_id}`
where `project` refers to a *project_id* or *project_number* and
`location_id` refers to a GCP region.
Generated from protobuf field <code>string name = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = {</code>
@return string | getName | php | googleapis/google-cloud-php | Dataplex/src/V1/GetDataScanRequest.php | https://github.com/googleapis/google-cloud-php/blob/master/Dataplex/src/V1/GetDataScanRequest.php | Apache-2.0 |
public function setName($var)
{
GPBUtil::checkString($var, True);
$this->name = $var;
return $this;
} | Required. The resource name of the dataScan:
`projects/{project}/locations/{location_id}/dataScans/{data_scan_id}`
where `project` refers to a *project_id* or *project_number* and
`location_id` refers to a GCP region.
Generated from protobuf field <code>string name = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = {</code>
@param string $var
@return $this | setName | php | googleapis/google-cloud-php | Dataplex/src/V1/GetDataScanRequest.php | https://github.com/googleapis/google-cloud-php/blob/master/Dataplex/src/V1/GetDataScanRequest.php | Apache-2.0 |
public function getView()
{
return $this->view;
} | Optional. Select the DataScan view to return. Defaults to `BASIC`.
Generated from protobuf field <code>.google.cloud.dataplex.v1.GetDataScanRequest.DataScanView view = 2 [(.google.api.field_behavior) = OPTIONAL];</code>
@return int | getView | php | googleapis/google-cloud-php | Dataplex/src/V1/GetDataScanRequest.php | https://github.com/googleapis/google-cloud-php/blob/master/Dataplex/src/V1/GetDataScanRequest.php | Apache-2.0 |
public function setView($var)
{
GPBUtil::checkEnum($var, \Google\Cloud\Dataplex\V1\GetDataScanRequest\DataScanView::class);
$this->view = $var;
return $this;
} | Optional. Select the DataScan view to return. Defaults to `BASIC`.
Generated from protobuf field <code>.google.cloud.dataplex.v1.GetDataScanRequest.DataScanView view = 2 [(.google.api.field_behavior) = OPTIONAL];</code>
@param int $var
@return $this | setView | php | googleapis/google-cloud-php | Dataplex/src/V1/GetDataScanRequest.php | https://github.com/googleapis/google-cloud-php/blob/master/Dataplex/src/V1/GetDataScanRequest.php | Apache-2.0 |
public function getProjectId()
{
return $this->project_id;
} | Required. The ID of the Google Cloud Platform project that the cluster
belongs to.
Generated from protobuf field <code>string project_id = 1 [(.google.api.field_behavior) = REQUIRED];</code>
@return string | getProjectId | php | googleapis/google-cloud-php | Dataproc/src/V1/CreateClusterRequest.php | https://github.com/googleapis/google-cloud-php/blob/master/Dataproc/src/V1/CreateClusterRequest.php | Apache-2.0 |
public function setProjectId($var)
{
GPBUtil::checkString($var, True);
$this->project_id = $var;
return $this;
} | Required. The ID of the Google Cloud Platform project that the cluster
belongs to.
Generated from protobuf field <code>string project_id = 1 [(.google.api.field_behavior) = REQUIRED];</code>
@param string $var
@return $this | setProjectId | php | googleapis/google-cloud-php | Dataproc/src/V1/CreateClusterRequest.php | https://github.com/googleapis/google-cloud-php/blob/master/Dataproc/src/V1/CreateClusterRequest.php | Apache-2.0 |
public function getRegion()
{
return $this->region;
} | Required. The Dataproc region in which to handle the request.
Generated from protobuf field <code>string region = 3 [(.google.api.field_behavior) = REQUIRED];</code>
@return string | getRegion | php | googleapis/google-cloud-php | Dataproc/src/V1/CreateClusterRequest.php | https://github.com/googleapis/google-cloud-php/blob/master/Dataproc/src/V1/CreateClusterRequest.php | Apache-2.0 |
public function setRegion($var)
{
GPBUtil::checkString($var, True);
$this->region = $var;
return $this;
} | Required. The Dataproc region in which to handle the request.
Generated from protobuf field <code>string region = 3 [(.google.api.field_behavior) = REQUIRED];</code>
@param string $var
@return $this | setRegion | php | googleapis/google-cloud-php | Dataproc/src/V1/CreateClusterRequest.php | https://github.com/googleapis/google-cloud-php/blob/master/Dataproc/src/V1/CreateClusterRequest.php | Apache-2.0 |
public function getCluster()
{
return $this->cluster;
} | Required. The cluster to create.
Generated from protobuf field <code>.google.cloud.dataproc.v1.Cluster cluster = 2 [(.google.api.field_behavior) = REQUIRED];</code>
@return \Google\Cloud\Dataproc\V1\Cluster|null | getCluster | php | googleapis/google-cloud-php | Dataproc/src/V1/CreateClusterRequest.php | https://github.com/googleapis/google-cloud-php/blob/master/Dataproc/src/V1/CreateClusterRequest.php | Apache-2.0 |
public function setCluster($var)
{
GPBUtil::checkMessage($var, \Google\Cloud\Dataproc\V1\Cluster::class);
$this->cluster = $var;
return $this;
} | Required. The cluster to create.
Generated from protobuf field <code>.google.cloud.dataproc.v1.Cluster cluster = 2 [(.google.api.field_behavior) = REQUIRED];</code>
@param \Google\Cloud\Dataproc\V1\Cluster $var
@return $this | setCluster | php | googleapis/google-cloud-php | Dataproc/src/V1/CreateClusterRequest.php | https://github.com/googleapis/google-cloud-php/blob/master/Dataproc/src/V1/CreateClusterRequest.php | Apache-2.0 |
public function getRequestId()
{
return $this->request_id;
} | Optional. A unique ID used to identify the request. If the server receives
two
[CreateClusterRequest](https://cloud.google.com/dataproc/docs/reference/rpc/google.cloud.dataproc.v1#google.cloud.dataproc.v1.CreateClusterRequest)s
with the same id, then the second request will be ignored and the
first [google.longrunning.Operation][google.longrunning.Operation] created
and stored in the backend is returned.
It is recommended to always set this value to a
[UUID](https://en.wikipedia.org/wiki/Universally_unique_identifier).
The ID must contain only letters (a-z, A-Z), numbers (0-9),
underscores (_), and hyphens (-). The maximum length is 40 characters.
Generated from protobuf field <code>string request_id = 4 [(.google.api.field_behavior) = OPTIONAL];</code>
@return string | getRequestId | php | googleapis/google-cloud-php | Dataproc/src/V1/CreateClusterRequest.php | https://github.com/googleapis/google-cloud-php/blob/master/Dataproc/src/V1/CreateClusterRequest.php | Apache-2.0 |
public function setRequestId($var)
{
GPBUtil::checkString($var, True);
$this->request_id = $var;
return $this;
} | Optional. A unique ID used to identify the request. If the server receives
two
[CreateClusterRequest](https://cloud.google.com/dataproc/docs/reference/rpc/google.cloud.dataproc.v1#google.cloud.dataproc.v1.CreateClusterRequest)s
with the same id, then the second request will be ignored and the
first [google.longrunning.Operation][google.longrunning.Operation] created
and stored in the backend is returned.
It is recommended to always set this value to a
[UUID](https://en.wikipedia.org/wiki/Universally_unique_identifier).
The ID must contain only letters (a-z, A-Z), numbers (0-9),
underscores (_), and hyphens (-). The maximum length is 40 characters.
Generated from protobuf field <code>string request_id = 4 [(.google.api.field_behavior) = OPTIONAL];</code>
@param string $var
@return $this | setRequestId | php | googleapis/google-cloud-php | Dataproc/src/V1/CreateClusterRequest.php | https://github.com/googleapis/google-cloud-php/blob/master/Dataproc/src/V1/CreateClusterRequest.php | Apache-2.0 |
public function getActionOnFailedPrimaryWorkers()
{
return $this->action_on_failed_primary_workers;
} | Optional. Failure action when primary worker creation fails.
Generated from protobuf field <code>.google.cloud.dataproc.v1.FailureAction action_on_failed_primary_workers = 5 [(.google.api.field_behavior) = OPTIONAL];</code>
@return int | getActionOnFailedPrimaryWorkers | php | googleapis/google-cloud-php | Dataproc/src/V1/CreateClusterRequest.php | https://github.com/googleapis/google-cloud-php/blob/master/Dataproc/src/V1/CreateClusterRequest.php | Apache-2.0 |
public function setActionOnFailedPrimaryWorkers($var)
{
GPBUtil::checkEnum($var, \Google\Cloud\Dataproc\V1\FailureAction::class);
$this->action_on_failed_primary_workers = $var;
return $this;
} | Optional. Failure action when primary worker creation fails.
Generated from protobuf field <code>.google.cloud.dataproc.v1.FailureAction action_on_failed_primary_workers = 5 [(.google.api.field_behavior) = OPTIONAL];</code>
@param int $var
@return $this | setActionOnFailedPrimaryWorkers | php | googleapis/google-cloud-php | Dataproc/src/V1/CreateClusterRequest.php | https://github.com/googleapis/google-cloud-php/blob/master/Dataproc/src/V1/CreateClusterRequest.php | Apache-2.0 |
public function getUser()
{
return $this->user;
} | Required. The new version of the user.
Use `me` to refer to your own email address, for example
`accounts/{account}/users/me`.
Generated from protobuf field <code>.google.shopping.merchant.accounts.v1beta.User user = 1 [(.google.api.field_behavior) = REQUIRED];</code>
@return \Google\Shopping\Merchant\Accounts\V1beta\User|null | getUser | php | googleapis/google-cloud-php | ShoppingMerchantAccounts/src/V1beta/UpdateUserRequest.php | https://github.com/googleapis/google-cloud-php/blob/master/ShoppingMerchantAccounts/src/V1beta/UpdateUserRequest.php | Apache-2.0 |
public function setUser($var)
{
GPBUtil::checkMessage($var, \Google\Shopping\Merchant\Accounts\V1beta\User::class);
$this->user = $var;
return $this;
} | Required. The new version of the user.
Use `me` to refer to your own email address, for example
`accounts/{account}/users/me`.
Generated from protobuf field <code>.google.shopping.merchant.accounts.v1beta.User user = 1 [(.google.api.field_behavior) = REQUIRED];</code>
@param \Google\Shopping\Merchant\Accounts\V1beta\User $var
@return $this | setUser | php | googleapis/google-cloud-php | ShoppingMerchantAccounts/src/V1beta/UpdateUserRequest.php | https://github.com/googleapis/google-cloud-php/blob/master/ShoppingMerchantAccounts/src/V1beta/UpdateUserRequest.php | Apache-2.0 |
public function getUpdateMask()
{
return $this->update_mask;
} | Required. List of fields being updated.
Generated from protobuf field <code>.google.protobuf.FieldMask update_mask = 2 [(.google.api.field_behavior) = REQUIRED];</code>
@return \Google\Protobuf\FieldMask|null | getUpdateMask | php | googleapis/google-cloud-php | ShoppingMerchantAccounts/src/V1beta/UpdateUserRequest.php | https://github.com/googleapis/google-cloud-php/blob/master/ShoppingMerchantAccounts/src/V1beta/UpdateUserRequest.php | Apache-2.0 |
public function setUpdateMask($var)
{
GPBUtil::checkMessage($var, \Google\Protobuf\FieldMask::class);
$this->update_mask = $var;
return $this;
} | Required. List of fields being updated.
Generated from protobuf field <code>.google.protobuf.FieldMask update_mask = 2 [(.google.api.field_behavior) = REQUIRED];</code>
@param \Google\Protobuf\FieldMask $var
@return $this | setUpdateMask | php | googleapis/google-cloud-php | ShoppingMerchantAccounts/src/V1beta/UpdateUserRequest.php | https://github.com/googleapis/google-cloud-php/blob/master/ShoppingMerchantAccounts/src/V1beta/UpdateUserRequest.php | Apache-2.0 |
public function getFilter()
{
return isset($this->filter) ? $this->filter : '';
} | A filter expression that filters resources listed in the response. Most Compute resources support two types of filter expressions: expressions that support regular expressions and expressions that follow API improvement proposal AIP-160. These two types of filter expressions cannot be mixed in one request. If you want to use AIP-160, your expression must specify the field name, an operator, and the value that you want to use for filtering. The value must be a string, a number, or a boolean. The operator must be either `=`, `!=`, `>`, `<`, `<=`, `>=` or `:`. For example, if you are filtering Compute Engine instances, you can exclude instances named `example-instance` by specifying `name != example-instance`. The `:*` comparison can be used to test whether a key has been defined. For example, to find all objects with `owner` label use: ``` labels.owner:* ``` You can also filter nested fields. For example, you could specify `scheduling.automaticRestart = false` to include instances only if they are not scheduled for automatic restarts. You can use filtering on nested fields to filter based on resource labels. To filter on multiple expressions, provide each separate expression within parentheses. For example: ``` (scheduling.automaticRestart = true) (cpuPlatform = "Intel Skylake") ``` By default, each expression is an `AND` expression. However, you can include `AND` and `OR` expressions explicitly. For example: ``` (cpuPlatform = "Intel Skylake") OR (cpuPlatform = "Intel Broadwell") AND (scheduling.automaticRestart = true) ``` If you want to use a regular expression, use the `eq` (equal) or `ne` (not equal) operator against a single un-parenthesized expression with or without quotes or against multiple parenthesized expressions. Examples: `fieldname eq unquoted literal` `fieldname eq 'single quoted literal'` `fieldname eq "double quoted literal"` `(fieldname1 eq literal) (fieldname2 ne "literal")` The literal value is interpreted as a regular expression using Google RE2 library syntax. The literal value must match the entire field. For example, to filter for instances that do not end with name "instance", you would use `name ne .*instance`. You cannot combine constraints on multiple fields using regular expressions.
Generated from protobuf field <code>optional string filter = 336120696;</code>
@return string | getFilter | php | googleapis/google-cloud-php | Compute/src/V1/ListRegionNetworkFirewallPoliciesRequest.php | https://github.com/googleapis/google-cloud-php/blob/master/Compute/src/V1/ListRegionNetworkFirewallPoliciesRequest.php | Apache-2.0 |
public function setFilter($var)
{
GPBUtil::checkString($var, True);
$this->filter = $var;
return $this;
} | A filter expression that filters resources listed in the response. Most Compute resources support two types of filter expressions: expressions that support regular expressions and expressions that follow API improvement proposal AIP-160. These two types of filter expressions cannot be mixed in one request. If you want to use AIP-160, your expression must specify the field name, an operator, and the value that you want to use for filtering. The value must be a string, a number, or a boolean. The operator must be either `=`, `!=`, `>`, `<`, `<=`, `>=` or `:`. For example, if you are filtering Compute Engine instances, you can exclude instances named `example-instance` by specifying `name != example-instance`. The `:*` comparison can be used to test whether a key has been defined. For example, to find all objects with `owner` label use: ``` labels.owner:* ``` You can also filter nested fields. For example, you could specify `scheduling.automaticRestart = false` to include instances only if they are not scheduled for automatic restarts. You can use filtering on nested fields to filter based on resource labels. To filter on multiple expressions, provide each separate expression within parentheses. For example: ``` (scheduling.automaticRestart = true) (cpuPlatform = "Intel Skylake") ``` By default, each expression is an `AND` expression. However, you can include `AND` and `OR` expressions explicitly. For example: ``` (cpuPlatform = "Intel Skylake") OR (cpuPlatform = "Intel Broadwell") AND (scheduling.automaticRestart = true) ``` If you want to use a regular expression, use the `eq` (equal) or `ne` (not equal) operator against a single un-parenthesized expression with or without quotes or against multiple parenthesized expressions. Examples: `fieldname eq unquoted literal` `fieldname eq 'single quoted literal'` `fieldname eq "double quoted literal"` `(fieldname1 eq literal) (fieldname2 ne "literal")` The literal value is interpreted as a regular expression using Google RE2 library syntax. The literal value must match the entire field. For example, to filter for instances that do not end with name "instance", you would use `name ne .*instance`. You cannot combine constraints on multiple fields using regular expressions.
Generated from protobuf field <code>optional string filter = 336120696;</code>
@param string $var
@return $this | setFilter | php | googleapis/google-cloud-php | Compute/src/V1/ListRegionNetworkFirewallPoliciesRequest.php | https://github.com/googleapis/google-cloud-php/blob/master/Compute/src/V1/ListRegionNetworkFirewallPoliciesRequest.php | Apache-2.0 |
public function getMaxResults()
{
return isset($this->max_results) ? $this->max_results : 0;
} | The maximum number of results per page that should be returned. If the number of available results is larger than `maxResults`, Compute Engine returns a `nextPageToken` that can be used to get the next page of results in subsequent list requests. Acceptable values are `0` to `500`, inclusive. (Default: `500`)
Generated from protobuf field <code>optional uint32 max_results = 54715419;</code>
@return int | getMaxResults | php | googleapis/google-cloud-php | Compute/src/V1/ListRegionNetworkFirewallPoliciesRequest.php | https://github.com/googleapis/google-cloud-php/blob/master/Compute/src/V1/ListRegionNetworkFirewallPoliciesRequest.php | Apache-2.0 |
public function setMaxResults($var)
{
GPBUtil::checkUint32($var);
$this->max_results = $var;
return $this;
} | The maximum number of results per page that should be returned. If the number of available results is larger than `maxResults`, Compute Engine returns a `nextPageToken` that can be used to get the next page of results in subsequent list requests. Acceptable values are `0` to `500`, inclusive. (Default: `500`)
Generated from protobuf field <code>optional uint32 max_results = 54715419;</code>
@param int $var
@return $this | setMaxResults | php | googleapis/google-cloud-php | Compute/src/V1/ListRegionNetworkFirewallPoliciesRequest.php | https://github.com/googleapis/google-cloud-php/blob/master/Compute/src/V1/ListRegionNetworkFirewallPoliciesRequest.php | Apache-2.0 |
public function getOrderBy()
{
return isset($this->order_by) ? $this->order_by : '';
} | Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name. You can also sort results in descending order based on the creation timestamp using `orderBy="creationTimestamp desc"`. This sorts results based on the `creationTimestamp` field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first. Currently, only sorting by `name` or `creationTimestamp desc` is supported.
Generated from protobuf field <code>optional string order_by = 160562920;</code>
@return string | getOrderBy | php | googleapis/google-cloud-php | Compute/src/V1/ListRegionNetworkFirewallPoliciesRequest.php | https://github.com/googleapis/google-cloud-php/blob/master/Compute/src/V1/ListRegionNetworkFirewallPoliciesRequest.php | Apache-2.0 |
Subsets and Splits
No community queries yet
The top public SQL queries from the community will appear here once available.