Google Cloud Vm Migration V1 Client - Class UtilizationReport (0.2.3)

Reference documentation and code samples for the Google Cloud Vm Migration V1 Client class UtilizationReport.

Utilization report details the utilization (CPU, memory, etc.) of selected source VMs.

Generated from protobuf message google.cloud.vmmigration.v1.UtilizationReport

Methods

__construct

Constructor.

Parameters
NameDescription
data array

Optional. Data for populating the Message object.

↳ name string

Output only. The report unique name.

↳ display_name string

The report display name, as assigned by the user.

↳ state int

Output only. Current state of the report.

↳ state_time Google\Protobuf\Timestamp

Output only. The time the state was last set.

↳ error Google\Rpc\Status

Output only. Provides details on the state of the report in case of an error.

↳ create_time Google\Protobuf\Timestamp

Output only. The time the report was created (this refers to the time of the request, not the time the report creation completed).

↳ time_frame int

Time frame of the report.

↳ frame_end_time Google\Protobuf\Timestamp

Output only. The point in time when the time frame ends. Notice that the time frame is counted backwards. For instance if the "frame_end_time" value is 2021/01/20 and the time frame is WEEK then the report covers the week between 2021/01/20 and 2021/01/14.

↳ vm_count int

Output only. Total number of VMs included in the report.

↳ vms array<Google\Cloud\VMMigration\V1\VmUtilizationInfo>

List of utilization information per VM. When sent as part of the request, the "vm_id" field is used in order to specify which VMs to include in the report. In that case all other fields are ignored.

getName

Output only. The report unique name.

Returns
TypeDescription
string

setName

Output only. The report unique name.

Parameter
NameDescription
var string
Returns
TypeDescription
$this

getDisplayName

The report display name, as assigned by the user.

Returns
TypeDescription
string

setDisplayName

The report display name, as assigned by the user.

Parameter
NameDescription
var string
Returns
TypeDescription
$this

getState

Output only. Current state of the report.

Returns
TypeDescription
int

setState

Output only. Current state of the report.

Parameter
NameDescription
var int
Returns
TypeDescription
$this

getStateTime

Output only. The time the state was last set.

Returns
TypeDescription
Google\Protobuf\Timestamp|null

hasStateTime

clearStateTime

setStateTime

Output only. The time the state was last set.

Parameter
NameDescription
var Google\Protobuf\Timestamp
Returns
TypeDescription
$this

getError

Output only. Provides details on the state of the report in case of an error.

Returns
TypeDescription
Google\Rpc\Status|null

hasError

clearError

setError

Output only. Provides details on the state of the report in case of an error.

Parameter
NameDescription
var Google\Rpc\Status
Returns
TypeDescription
$this

getCreateTime

Output only. The time the report was created (this refers to the time of the request, not the time the report creation completed).

Returns
TypeDescription
Google\Protobuf\Timestamp|null

hasCreateTime

clearCreateTime

setCreateTime

Output only. The time the report was created (this refers to the time of the request, not the time the report creation completed).

Parameter
NameDescription
var Google\Protobuf\Timestamp
Returns
TypeDescription
$this

getTimeFrame

Time frame of the report.

Returns
TypeDescription
int

setTimeFrame

Time frame of the report.

Parameter
NameDescription
var int
Returns
TypeDescription
$this

getFrameEndTime

Output only. The point in time when the time frame ends. Notice that the time frame is counted backwards. For instance if the "frame_end_time" value is 2021/01/20 and the time frame is WEEK then the report covers the week between 2021/01/20 and 2021/01/14.

Returns
TypeDescription
Google\Protobuf\Timestamp|null

hasFrameEndTime

clearFrameEndTime

setFrameEndTime

Output only. The point in time when the time frame ends. Notice that the time frame is counted backwards. For instance if the "frame_end_time" value is 2021/01/20 and the time frame is WEEK then the report covers the week between 2021/01/20 and 2021/01/14.

Parameter
NameDescription
var Google\Protobuf\Timestamp
Returns
TypeDescription
$this

getVmCount

Output only. Total number of VMs included in the report.

Returns
TypeDescription
int

setVmCount

Output only. Total number of VMs included in the report.

Parameter
NameDescription
var int
Returns
TypeDescription
$this

getVms

List of utilization information per VM.

When sent as part of the request, the "vm_id" field is used in order to specify which VMs to include in the report. In that case all other fields are ignored.

Returns
TypeDescription
Google\Protobuf\Internal\RepeatedField

setVms

List of utilization information per VM.

When sent as part of the request, the "vm_id" field is used in order to specify which VMs to include in the report. In that case all other fields are ignored.

Parameter
NameDescription
var array<Google\Cloud\VMMigration\V1\VmUtilizationInfo>
Returns
TypeDescription
$this