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

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

Namespace

Google \ Cloud \ VMMigration \ V1

Methods

__construct

Constructor.

Parameters
Name
Description
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< 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
Type
Description
string

setName

Output only. The report unique name.

Parameter
Name
Description
var
string
Returns
Type
Description
$this

getDisplayName

The report display name, as assigned by the user.

Returns
Type
Description
string

setDisplayName

The report display name, as assigned by the user.

Parameter
Name
Description
var
string
Returns
Type
Description
$this

getState

Output only. Current state of the report.

Returns
Type
Description
int

setState

Output only. Current state of the report.

Parameter
Name
Description
var
int
Returns
Type
Description
$this

getStateTime

Output only. The time the state was last set.

Returns
Type
Description

hasStateTime

clearStateTime

setStateTime

Output only. The time the state was last set.

Parameter
Name
Description
Returns
Type
Description
$this

getError

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

Returns
Type
Description

hasError

clearError

setError

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

Parameter
Name
Description
Returns
Type
Description
$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
Type
Description

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
Name
Description
Returns
Type
Description
$this

getTimeFrame

Time frame of the report.

Returns
Type
Description
int

setTimeFrame

Time frame of the report.

Parameter
Name
Description
var
int
Returns
Type
Description
$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
Type
Description

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
Name
Description
Returns
Type
Description
$this

getVmCount

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

Returns
Type
Description
int

setVmCount

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

Parameter
Name
Description
var
int
Returns
Type
Description
$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
Type
Description

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
Name
Description
var
Returns
Type
Description
$this
Design a Mobile Site
View Site in Mobile | Classic
Share by: