Recommender V1 Client - Class Impact (1.9.1)

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 \ V1

Methods

__construct

Constructor.

Parameters
NameDescription
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.RELAIBILITY

getCategory

Category that is being targeted.

Returns
TypeDescription
int

setCategory

Category that is being targeted.

Parameter
NameDescription
var int
Returns
TypeDescription
$this

getCostProjection

Use with CategoryType.COST

Returns
TypeDescription
Google\Cloud\Recommender\V1\CostProjection|null

hasCostProjection

setCostProjection

Use with CategoryType.COST

Parameter
NameDescription
var Google\Cloud\Recommender\V1\CostProjection
Returns
TypeDescription
$this

getSecurityProjection

Use with CategoryType.SECURITY

Returns
TypeDescription
Google\Cloud\Recommender\V1\SecurityProjection|null

hasSecurityProjection

setSecurityProjection

Use with CategoryType.SECURITY

Parameter
NameDescription
var Google\Cloud\Recommender\V1\SecurityProjection
Returns
TypeDescription
$this

getSustainabilityProjection

Use with CategoryType.SUSTAINABILITY

Returns
TypeDescription
Google\Cloud\Recommender\V1\SustainabilityProjection|null

hasSustainabilityProjection

setSustainabilityProjection

Use with CategoryType.SUSTAINABILITY

Parameter
NameDescription
var Google\Cloud\Recommender\V1\SustainabilityProjection
Returns
TypeDescription
$this

getReliabilityProjection

Use with CategoryType.RELAIBILITY

Returns
TypeDescription
Google\Cloud\Recommender\V1\ReliabilityProjection|null

hasReliabilityProjection

setReliabilityProjection

Use with CategoryType.RELAIBILITY

Parameter
NameDescription
var Google\Cloud\Recommender\V1\ReliabilityProjection
Returns
TypeDescription
$this

getProjection

Returns
TypeDescription
string