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 |
CostProjection
Use with CategoryType.COST |
↳ security_projection |
SecurityProjection
Use with CategoryType.SECURITY |
↳ sustainability_projection |
SustainabilityProjection
Use with CategoryType.SUSTAINABILITY |
↳ reliability_projection |
ReliabilityProjection
Use with CategoryType.RELIABILITY |
getCategory
Category that is being targeted.
| Returns | |
|---|---|
| Type | Description |
int |
Enum of type Category. |
setCategory
Category that is being targeted.
| Parameter | |
|---|---|
| Name | Description |
var |
int
Enum of type Category. |
| Returns | |
|---|---|
| Type | Description |
$this |
|
getCostProjection
Use with CategoryType.COST
| Returns | |
|---|---|
| Type | Description |
CostProjection|null |
|
hasCostProjection
setCostProjection
Use with CategoryType.COST
| Parameter | |
|---|---|
| Name | Description |
var |
CostProjection
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getSecurityProjection
Use with CategoryType.SECURITY
| Returns | |
|---|---|
| Type | Description |
SecurityProjection|null |
|
hasSecurityProjection
setSecurityProjection
Use with CategoryType.SECURITY
| Parameter | |
|---|---|
| Name | Description |
var |
SecurityProjection
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getSustainabilityProjection
Use with CategoryType.SUSTAINABILITY
| Returns | |
|---|---|
| Type | Description |
SustainabilityProjection|null |
|
hasSustainabilityProjection
setSustainabilityProjection
Use with CategoryType.SUSTAINABILITY
| Parameter | |
|---|---|
| Name | Description |
var |
SustainabilityProjection
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getReliabilityProjection
Use with CategoryType.RELIABILITY
| Returns | |
|---|---|
| Type | Description |
ReliabilityProjection|null |
|
hasReliabilityProjection
setReliabilityProjection
Use with CategoryType.RELIABILITY
| Parameter | |
|---|---|
| Name | Description |
var |
ReliabilityProjection
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getProjection
| Returns | |
|---|---|
| Type | Description |
string |
|