Reference documentation and code samples for the Recommender V1 Client class Impact.
Contains the impact a recommendation can have for a given category.
Generated from protobuf message google.cloud.recommender.v1.Impact
Namespace
Google \ Cloud \ Recommender \ V1Methods
__construct
Constructor.
| Parameters | |
|---|---|
| Name | Description |
data |
array
Optional. Data for populating the Message object. |
↳ category |
int
Category that is being targeted. |
↳ cost_projection |
Google\Cloud\Recommender\V1\CostProjection
Use with CategoryType.COST |
↳ security_projection |
Google\Cloud\Recommender\V1\SecurityProjection
Use with CategoryType.SECURITY |
↳ sustainability_projection |
Google\Cloud\Recommender\V1\SustainabilityProjection
Use with CategoryType.SUSTAINABILITY |
↳ reliability_projection |
Google\Cloud\Recommender\V1\ReliabilityProjection
Use with CategoryType.RELIABILITY |
getCategory
Category that is being targeted.
| Returns | |
|---|---|
| Type | Description |
int | |
setCategory
Category that is being targeted.
| Parameter | |
|---|---|
| Name | Description |
var |
int
|
| Returns | |
|---|---|
| Type | Description |
$this | |
getCostProjection
Use with CategoryType.COST
| Returns | |
|---|---|
| Type | Description |
Google\Cloud\Recommender\V1\CostProjection|null | |
hasCostProjection
setCostProjection
Use with CategoryType.COST
| Parameter | |
|---|---|
| Name | Description |
var |
Google\Cloud\Recommender\V1\CostProjection
|
| Returns | |
|---|---|
| Type | Description |
$this | |
getSecurityProjection
Use with CategoryType.SECURITY
| Returns | |
|---|---|
| Type | Description |
Google\Cloud\Recommender\V1\SecurityProjection|null | |
hasSecurityProjection
setSecurityProjection
Use with CategoryType.SECURITY
| Parameter | |
|---|---|
| Name | Description |
var |
Google\Cloud\Recommender\V1\SecurityProjection
|
| Returns | |
|---|---|
| Type | Description |
$this | |
getSustainabilityProjection
Use with CategoryType.SUSTAINABILITY
| Returns | |
|---|---|
| Type | Description |
Google\Cloud\Recommender\V1\SustainabilityProjection|null | |
hasSustainabilityProjection
setSustainabilityProjection
Use with CategoryType.SUSTAINABILITY
| Parameter | |
|---|---|
| Name | Description |
var |
Google\Cloud\Recommender\V1\SustainabilityProjection
|
| Returns | |
|---|---|
| Type | Description |
$this | |
getReliabilityProjection
Use with CategoryType.RELIABILITY
| Returns | |
|---|---|
| Type | Description |
Google\Cloud\Recommender\V1\ReliabilityProjection|null | |
hasReliabilityProjection
setReliabilityProjection
Use with CategoryType.RELIABILITY
| Parameter | |
|---|---|
| Name | Description |
var |
Google\Cloud\Recommender\V1\ReliabilityProjection
|
| Returns | |
|---|---|
| Type | Description |
$this | |
getProjection
| Returns | |
|---|---|
| Type | Description |
string | |