Interface UtilizationReportOrBuilder (1.52.0)

public interface UtilizationReportOrBuilder extends MessageOrBuilder

Implements

MessageOrBuilder

Methods

getCreateTime()

public abstract Timestamp getCreateTime()

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

.google.protobuf.Timestamp create_time = 6 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
Timestamp

The createTime.

getCreateTimeOrBuilder()

public abstract TimestampOrBuilder getCreateTimeOrBuilder()

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

.google.protobuf.Timestamp create_time = 6 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
TimestampOrBuilder

getDisplayName()

public abstract String getDisplayName()

The report display name, as assigned by the user.

string display_name = 2;

Returns
Type Description
String

The displayName.

getDisplayNameBytes()

public abstract ByteString getDisplayNameBytes()

The report display name, as assigned by the user.

string display_name = 2;

Returns
Type Description
ByteString

The bytes for displayName.

getError()

public abstract Status getError()

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

.google.rpc.Status error = 5 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
com.google.rpc.Status

The error.

getErrorOrBuilder()

public abstract StatusOrBuilder getErrorOrBuilder()

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

.google.rpc.Status error = 5 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
com.google.rpc.StatusOrBuilder

getFrameEndTime()

public abstract Timestamp 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.

.google.protobuf.Timestamp frame_end_time = 8 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
Timestamp

The frameEndTime.

getFrameEndTimeOrBuilder()

public abstract TimestampOrBuilder getFrameEndTimeOrBuilder()

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.

.google.protobuf.Timestamp frame_end_time = 8 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
TimestampOrBuilder

getName()

public abstract String getName()

Output only. The report unique name.

string name = 1 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
String

The name.

getNameBytes()

public abstract ByteString getNameBytes()

Output only. The report unique name.

string name = 1 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
ByteString

The bytes for name.

getState()

public abstract UtilizationReport.State getState()

Output only. Current state of the report.

.google.cloud.vmmigration.v1.UtilizationReport.State state = 3 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
UtilizationReport.State

The state.

getStateTime()

public abstract Timestamp getStateTime()

Output only. The time the state was last set.

.google.protobuf.Timestamp state_time = 4 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
Timestamp

The stateTime.

getStateTimeOrBuilder()

public abstract TimestampOrBuilder getStateTimeOrBuilder()

Output only. The time the state was last set.

.google.protobuf.Timestamp state_time = 4 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
TimestampOrBuilder

getStateValue()

public abstract int getStateValue()

Output only. Current state of the report.

.google.cloud.vmmigration.v1.UtilizationReport.State state = 3 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
int

The enum numeric value on the wire for state.

getTimeFrame()

public abstract UtilizationReport.TimeFrame getTimeFrame()

Time frame of the report.

.google.cloud.vmmigration.v1.UtilizationReport.TimeFrame time_frame = 7;

Returns
Type Description
UtilizationReport.TimeFrame

The timeFrame.

getTimeFrameValue()

public abstract int getTimeFrameValue()

Time frame of the report.

.google.cloud.vmmigration.v1.UtilizationReport.TimeFrame time_frame = 7;

Returns
Type Description
int

The enum numeric value on the wire for timeFrame.

getVmCount()

public abstract int getVmCount()

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

int32 vm_count = 9 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
int

The vmCount.

getVms(int index)

public abstract VmUtilizationInfo getVms(int index)

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.

repeated .google.cloud.vmmigration.v1.VmUtilizationInfo vms = 10;

Parameter
Name Description
index int
Returns
Type Description
VmUtilizationInfo

getVmsCount()

public abstract int getVmsCount()

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.

repeated .google.cloud.vmmigration.v1.VmUtilizationInfo vms = 10;

Returns
Type Description
int

getVmsList()

public abstract List<VmUtilizationInfo> getVmsList()

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.

repeated .google.cloud.vmmigration.v1.VmUtilizationInfo vms = 10;

Returns
Type Description
List<VmUtilizationInfo>

getVmsOrBuilder(int index)

public abstract VmUtilizationInfoOrBuilder getVmsOrBuilder(int index)

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.

repeated .google.cloud.vmmigration.v1.VmUtilizationInfo vms = 10;

Parameter
Name Description
index int
Returns
Type Description
VmUtilizationInfoOrBuilder

getVmsOrBuilderList()

public abstract List<? extends VmUtilizationInfoOrBuilder> getVmsOrBuilderList()

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.

repeated .google.cloud.vmmigration.v1.VmUtilizationInfo vms = 10;

Returns
Type Description
List<? extends com.google.cloud.vmmigration.v1.VmUtilizationInfoOrBuilder>

hasCreateTime()

public abstract boolean hasCreateTime()

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

.google.protobuf.Timestamp create_time = 6 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
boolean

Whether the createTime field is set.

hasError()

public abstract boolean hasError()

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

.google.rpc.Status error = 5 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
boolean

Whether the error field is set.

hasFrameEndTime()

public abstract boolean hasFrameEndTime()

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.

.google.protobuf.Timestamp frame_end_time = 8 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
boolean

Whether the frameEndTime field is set.

hasStateTime()

public abstract boolean hasStateTime()

Output only. The time the state was last set.

.google.protobuf.Timestamp state_time = 4 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
boolean

Whether the stateTime field is set.