Recommender V1 Client - Class MarkRecommendationClaimedRequest (2.0.0)

Reference documentation and code samples for the Recommender V1 Client class MarkRecommendationClaimedRequest.

Request for the MarkRecommendationClaimed Method.

Generated from protobuf message google.cloud.recommender.v1.MarkRecommendationClaimedRequest

Namespace

Google \ Cloud \ Recommender \ V1

Methods

__construct

Constructor.

Parameters
Name Description
data array

Optional. Data for populating the Message object.

↳ name string

Required. Name of the recommendation.

↳ state_metadata array|Google\Protobuf\Internal\MapField

State properties to include with this state. Overwrites any existing state_metadata. Keys must match the regex /^[a-z0-9][a-z0-9_.-]{0,62}$/. Values must match the regex /^[a-zA-Z0-9_./-]{0,255}$/.

↳ etag string

Required. Fingerprint of the Recommendation. Provides optimistic locking.

getName

Required. Name of the recommendation.

Returns
Type Description
string

setName

Required. Name of the recommendation.

Parameter
Name Description
var string
Returns
Type Description
$this

getStateMetadata

State properties to include with this state. Overwrites any existing state_metadata.

Keys must match the regex /^[a-z0-9][a-z0-9_.-]{0,62}$/. Values must match the regex /^[a-zA-Z0-9_./-]{0,255}$/.

Returns
Type Description
Google\Protobuf\Internal\MapField

setStateMetadata

State properties to include with this state. Overwrites any existing state_metadata.

Keys must match the regex /^[a-z0-9][a-z0-9_.-]{0,62}$/. Values must match the regex /^[a-zA-Z0-9_./-]{0,255}$/.

Parameter
Name Description
var array|Google\Protobuf\Internal\MapField
Returns
Type Description
$this

getEtag

Required. Fingerprint of the Recommendation. Provides optimistic locking.

Returns
Type Description
string

setEtag

Required. Fingerprint of the Recommendation. Provides optimistic locking.

Parameter
Name Description
var string
Returns
Type Description
$this

static::build

Parameters
Name Description
name string

Required. Name of the recommendation. Please see Google\Cloud\Recommender\V1\RecommenderClient::recommendationName() for help formatting this field.

stateMetadata array

State properties to include with this state. Overwrites any existing state_metadata. Keys must match the regex /^[a-z0-9][a-z0-9_.-]{0,62}$/. Values must match the regex /^[a-zA-Z0-9_./-]{0,255}$/.

etag string

Required. Fingerprint of the Recommendation. Provides optimistic locking.

Returns
Type Description
Google\Cloud\Recommender\V1\MarkRecommendationClaimedRequest