Recommender V1 Client - Class MarkRecommendationFailedRequest (1.10.0)

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

Request for the MarkRecommendationFailed Method.

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

Namespace

Google \ Cloud \ Recommender \ V1

Methods

__construct

Constructor.

Parameters
NameDescription
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
TypeDescription
string

setName

Required. Name of the recommendation.

Parameter
NameDescription
var string
Returns
TypeDescription
$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
TypeDescription
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
NameDescription
var array|Google\Protobuf\Internal\MapField
Returns
TypeDescription
$this

getEtag

Required. Fingerprint of the Recommendation. Provides optimistic locking.

Returns
TypeDescription
string

setEtag

Required. Fingerprint of the Recommendation. Provides optimistic locking.

Parameter
NameDescription
var string
Returns
TypeDescription
$this

static::build

Parameters
NameDescription
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
TypeDescription
Google\Cloud\Recommender\V1\MarkRecommendationFailedRequest