Reference documentation and code samples for the Recommender V1 Client class MarkRecommendationSucceededRequest.
Request for the MarkRecommendationSucceeded Method.
Generated from protobuf message google.cloud.recommender.v1.MarkRecommendationSucceededRequest
Namespace
Google \ Cloud \ Recommender \ V1Methods
__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 |
↳ 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 RecommenderClient::recommendationName() for help formatting this field. |
stateMetadata |
array
State properties to include with this state. Overwrites any existing
|
etag |
string
Required. Fingerprint of the Recommendation. Provides optimistic locking. |
| Returns | |
|---|---|
| Type | Description |
MarkRecommendationSucceededRequest |
|