Google Cloud Quotas V1 Client - Class UpdateQuotaPreferenceRequest (0.2.2)

Reference documentation and code samples for the Google Cloud Quotas V1 Client class UpdateQuotaPreferenceRequest.

Message for updating a QuotaPreference

Generated from protobuf message google.api.cloudquotas.v1.UpdateQuotaPreferenceRequest

Namespace

Google \ Cloud \ CloudQuotas \ V1

Methods

__construct

Constructor.

Parameters
Name Description
data array

Optional. Data for populating the Message object.

↳ update_mask Google\Protobuf\FieldMask

Optional. Field mask is used to specify the fields to be overwritten in the QuotaPreference resource by the update. The fields specified in the update_mask are relative to the resource, not the full request. A field will be overwritten if it is in the mask. If the user does not provide a mask then all fields will be overwritten.

↳ quota_preference Google\Cloud\CloudQuotas\V1\QuotaPreference

Required. The resource being updated

↳ allow_missing bool

Optional. If set to true, and the quota preference is not found, a new one will be created. In this situation, update_mask is ignored.

↳ validate_only bool

Optional. If set to true, validate the request, but do not actually update. Note that a request being valid does not mean that the request is guaranteed to be fulfilled.

↳ ignore_safety_checks array

The list of quota safety checks to be ignored.

getUpdateMask

Optional. Field mask is used to specify the fields to be overwritten in the QuotaPreference resource by the update.

The fields specified in the update_mask are relative to the resource, not the full request. A field will be overwritten if it is in the mask. If the user does not provide a mask then all fields will be overwritten.

Returns
Type Description
Google\Protobuf\FieldMask|null

hasUpdateMask

clearUpdateMask

setUpdateMask

Optional. Field mask is used to specify the fields to be overwritten in the QuotaPreference resource by the update.

The fields specified in the update_mask are relative to the resource, not the full request. A field will be overwritten if it is in the mask. If the user does not provide a mask then all fields will be overwritten.

Parameter
Name Description
var Google\Protobuf\FieldMask
Returns
Type Description
$this

getQuotaPreference

Required. The resource being updated

Returns
Type Description
Google\Cloud\CloudQuotas\V1\QuotaPreference|null

hasQuotaPreference

clearQuotaPreference

setQuotaPreference

Required. The resource being updated

Parameter
Name Description
var Google\Cloud\CloudQuotas\V1\QuotaPreference
Returns
Type Description
$this

getAllowMissing

Optional. If set to true, and the quota preference is not found, a new one will be created. In this situation, update_mask is ignored.

Returns
Type Description
bool

setAllowMissing

Optional. If set to true, and the quota preference is not found, a new one will be created. In this situation, update_mask is ignored.

Parameter
Name Description
var bool
Returns
Type Description
$this

getValidateOnly

Optional. If set to true, validate the request, but do not actually update.

Note that a request being valid does not mean that the request is guaranteed to be fulfilled.

Returns
Type Description
bool

setValidateOnly

Optional. If set to true, validate the request, but do not actually update.

Note that a request being valid does not mean that the request is guaranteed to be fulfilled.

Parameter
Name Description
var bool
Returns
Type Description
$this

getIgnoreSafetyChecks

The list of quota safety checks to be ignored.

Returns
Type Description
Google\Protobuf\Internal\RepeatedField

setIgnoreSafetyChecks

The list of quota safety checks to be ignored.

Parameter
Name Description
var int[]
Returns
Type Description
$this

static::build

Parameters
Name Description
quotaPreference Google\Cloud\CloudQuotas\V1\QuotaPreference

Required. The resource being updated

updateMask Google\Protobuf\FieldMask

Optional. Field mask is used to specify the fields to be overwritten in the QuotaPreference resource by the update. The fields specified in the update_mask are relative to the resource, not the full request. A field will be overwritten if it is in the mask. If the user does not provide a mask then all fields will be overwritten.

Returns
Type Description
Google\Cloud\CloudQuotas\V1\UpdateQuotaPreferenceRequest