Class UtilizationReport (1.41.0)

public final class UtilizationReport extends GeneratedMessageV3 implements UtilizationReportOrBuilder

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

Protobuf type google.cloud.vmmigration.v1.UtilizationReport

Static Fields

CREATE_TIME_FIELD_NUMBER

public static final int CREATE_TIME_FIELD_NUMBER
Field Value
TypeDescription
int

DISPLAY_NAME_FIELD_NUMBER

public static final int DISPLAY_NAME_FIELD_NUMBER
Field Value
TypeDescription
int

ERROR_FIELD_NUMBER

public static final int ERROR_FIELD_NUMBER
Field Value
TypeDescription
int

FRAME_END_TIME_FIELD_NUMBER

public static final int FRAME_END_TIME_FIELD_NUMBER
Field Value
TypeDescription
int

NAME_FIELD_NUMBER

public static final int NAME_FIELD_NUMBER
Field Value
TypeDescription
int

STATE_FIELD_NUMBER

public static final int STATE_FIELD_NUMBER
Field Value
TypeDescription
int

STATE_TIME_FIELD_NUMBER

public static final int STATE_TIME_FIELD_NUMBER
Field Value
TypeDescription
int

TIME_FRAME_FIELD_NUMBER

public static final int TIME_FRAME_FIELD_NUMBER
Field Value
TypeDescription
int

VMS_FIELD_NUMBER

public static final int VMS_FIELD_NUMBER
Field Value
TypeDescription
int

VM_COUNT_FIELD_NUMBER

public static final int VM_COUNT_FIELD_NUMBER
Field Value
TypeDescription
int

Static Methods

getDefaultInstance()

public static UtilizationReport getDefaultInstance()
Returns
TypeDescription
UtilizationReport

getDescriptor()

public static final Descriptors.Descriptor getDescriptor()
Returns
TypeDescription
Descriptor

newBuilder()

public static UtilizationReport.Builder newBuilder()
Returns
TypeDescription
UtilizationReport.Builder

newBuilder(UtilizationReport prototype)

public static UtilizationReport.Builder newBuilder(UtilizationReport prototype)
Parameter
NameDescription
prototypeUtilizationReport
Returns
TypeDescription
UtilizationReport.Builder

parseDelimitedFrom(InputStream input)

public static UtilizationReport parseDelimitedFrom(InputStream input)
Parameter
NameDescription
inputInputStream
Returns
TypeDescription
UtilizationReport
Exceptions
TypeDescription
IOException

parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static UtilizationReport parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
inputInputStream
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
UtilizationReport
Exceptions
TypeDescription
IOException

parseFrom(byte[] data)

public static UtilizationReport parseFrom(byte[] data)
Parameter
NameDescription
databyte[]
Returns
TypeDescription
UtilizationReport
Exceptions
TypeDescription
InvalidProtocolBufferException

parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)

public static UtilizationReport parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
databyte[]
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
UtilizationReport
Exceptions
TypeDescription
InvalidProtocolBufferException

parseFrom(ByteString data)

public static UtilizationReport parseFrom(ByteString data)
Parameter
NameDescription
dataByteString
Returns
TypeDescription
UtilizationReport
Exceptions
TypeDescription
InvalidProtocolBufferException

parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)

public static UtilizationReport parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
dataByteString
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
UtilizationReport
Exceptions
TypeDescription
InvalidProtocolBufferException

parseFrom(CodedInputStream input)

public static UtilizationReport parseFrom(CodedInputStream input)
Parameter
NameDescription
inputCodedInputStream
Returns
TypeDescription
UtilizationReport
Exceptions
TypeDescription
IOException

parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public static UtilizationReport parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
inputCodedInputStream
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
UtilizationReport
Exceptions
TypeDescription
IOException

parseFrom(InputStream input)

public static UtilizationReport parseFrom(InputStream input)
Parameter
NameDescription
inputInputStream
Returns
TypeDescription
UtilizationReport
Exceptions
TypeDescription
IOException

parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static UtilizationReport parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
inputInputStream
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
UtilizationReport
Exceptions
TypeDescription
IOException

parseFrom(ByteBuffer data)

public static UtilizationReport parseFrom(ByteBuffer data)
Parameter
NameDescription
dataByteBuffer
Returns
TypeDescription
UtilizationReport
Exceptions
TypeDescription
InvalidProtocolBufferException

parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)

public static UtilizationReport parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
dataByteBuffer
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
UtilizationReport
Exceptions
TypeDescription
InvalidProtocolBufferException

parser()

public static Parser<UtilizationReport> parser()
Returns
TypeDescription
Parser<UtilizationReport>

Methods

equals(Object obj)

public boolean equals(Object obj)
Parameter
NameDescription
objObject
Returns
TypeDescription
boolean
Overrides

getCreateTime()

public 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
TypeDescription
Timestamp

The createTime.

getCreateTimeOrBuilder()

public 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
TypeDescription
TimestampOrBuilder

getDefaultInstanceForType()

public UtilizationReport getDefaultInstanceForType()
Returns
TypeDescription
UtilizationReport

getDisplayName()

public String getDisplayName()

The report display name, as assigned by the user.

string display_name = 2;

Returns
TypeDescription
String

The displayName.

getDisplayNameBytes()

public ByteString getDisplayNameBytes()

The report display name, as assigned by the user.

string display_name = 2;

Returns
TypeDescription
ByteString

The bytes for displayName.

getError()

public 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
TypeDescription
com.google.rpc.Status

The error.

getErrorOrBuilder()

public 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
TypeDescription
com.google.rpc.StatusOrBuilder

getFrameEndTime()

public 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
TypeDescription
Timestamp

The frameEndTime.

getFrameEndTimeOrBuilder()

public 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
TypeDescription
TimestampOrBuilder

getName()

public String getName()

Output only. The report unique name.

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

Returns
TypeDescription
String

The name.

getNameBytes()

public ByteString getNameBytes()

Output only. The report unique name.

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

Returns
TypeDescription
ByteString

The bytes for name.

getParserForType()

public Parser<UtilizationReport> getParserForType()
Returns
TypeDescription
Parser<UtilizationReport>
Overrides

getSerializedSize()

public int getSerializedSize()
Returns
TypeDescription
int
Overrides

getState()

public 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
TypeDescription
UtilizationReport.State

The state.

getStateTime()

public Timestamp getStateTime()

Output only. The time the state was last set.

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

Returns
TypeDescription
Timestamp

The stateTime.

getStateTimeOrBuilder()

public TimestampOrBuilder getStateTimeOrBuilder()

Output only. The time the state was last set.

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

Returns
TypeDescription
TimestampOrBuilder

getStateValue()

public int getStateValue()

Output only. Current state of the report.

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

Returns
TypeDescription
int

The enum numeric value on the wire for state.

getTimeFrame()

public UtilizationReport.TimeFrame getTimeFrame()

Time frame of the report.

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

Returns
TypeDescription
UtilizationReport.TimeFrame

The timeFrame.

getTimeFrameValue()

public int getTimeFrameValue()

Time frame of the report.

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

Returns
TypeDescription
int

The enum numeric value on the wire for timeFrame.

getVmCount()

public int getVmCount()

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

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

Returns
TypeDescription
int

The vmCount.

getVms(int index)

public 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
NameDescription
indexint
Returns
TypeDescription
VmUtilizationInfo

getVmsCount()

public 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
TypeDescription
int

getVmsList()

public 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
TypeDescription
List<VmUtilizationInfo>

getVmsOrBuilder(int index)

public 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
NameDescription
indexint
Returns
TypeDescription
VmUtilizationInfoOrBuilder

getVmsOrBuilderList()

public 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
TypeDescription
List<? extends com.google.cloud.vmmigration.v1.VmUtilizationInfoOrBuilder>

hasCreateTime()

public 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
TypeDescription
boolean

Whether the createTime field is set.

hasError()

public 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
TypeDescription
boolean

Whether the error field is set.

hasFrameEndTime()

public 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
TypeDescription
boolean

Whether the frameEndTime field is set.

hasStateTime()

public boolean hasStateTime()

Output only. The time the state was last set.

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

Returns
TypeDescription
boolean

Whether the stateTime field is set.

hashCode()

public int hashCode()
Returns
TypeDescription
int
Overrides

internalGetFieldAccessorTable()

protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Returns
TypeDescription
FieldAccessorTable
Overrides

isInitialized()

public final boolean isInitialized()
Returns
TypeDescription
boolean
Overrides

newBuilderForType()

public UtilizationReport.Builder newBuilderForType()
Returns
TypeDescription
UtilizationReport.Builder

newBuilderForType(GeneratedMessageV3.BuilderParent parent)

protected UtilizationReport.Builder newBuilderForType(GeneratedMessageV3.BuilderParent parent)
Parameter
NameDescription
parentBuilderParent
Returns
TypeDescription
UtilizationReport.Builder
Overrides

newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)

protected Object newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
Parameter
NameDescription
unusedUnusedPrivateParameter
Returns
TypeDescription
Object
Overrides

toBuilder()

public UtilizationReport.Builder toBuilder()
Returns
TypeDescription
UtilizationReport.Builder

writeTo(CodedOutputStream output)

public void writeTo(CodedOutputStream output)
Parameter
NameDescription
outputCodedOutputStream
Overrides
Exceptions
TypeDescription
IOException