Class: Google::Cloud::VMMigration::V1::UtilizationReport

Inherits:
Object
  • Object
show all
Extended by:
Protobuf::MessageExts::ClassMethods
Includes:
Protobuf::MessageExts
Defined in:
proto_docs/google/cloud/vmmigration/v1/vmmigration.rb

Overview

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

Defined Under Namespace

Modules: State, TimeFrame

Instance Attribute Summary collapse

Instance Attribute Details

#create_time ⇒ ::Google::Protobuf::Timestamp (readonly)

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

Returns:

  • (::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).



1322
1323
1324
1325
1326
1327
1328
1329
1330
1331
1332
1333
1334
1335
1336
1337
1338
1339
1340
1341
1342
1343
1344
1345
1346
1347
1348
1349
1350
1351
1352
1353
1354
1355
 
# File 'proto_docs/google/cloud/vmmigration/v1/vmmigration.rb', line 1322

class UtilizationReport
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # Utilization report state.
  module State
    # The state is unknown. This value is not in use.
    STATE_UNSPECIFIED = 0

    # The report is in the making.
    CREATING = 1

    # Report creation completed successfully.
    SUCCEEDED = 2

    # Report creation failed.
    FAILED = 3
  end

  # Report time frame options.
  module TimeFrame
    # The time frame was not specified and will default to WEEK.
    TIME_FRAME_UNSPECIFIED = 0

    # One week.
    WEEK = 1

    # One month.
    MONTH = 2

    # One year.
    YEAR = 3
  end
end

#display_name ⇒ ::String

Returns The report display name, as assigned by the user.

Returns:

  • (::String) —

    The report display name, as assigned by the user.



1322
1323
1324
1325
1326
1327
1328
1329
1330
1331
1332
1333
1334
1335
1336
1337
1338
1339
1340
1341
1342
1343
1344
1345
1346
1347
1348
1349
1350
1351
1352
1353
1354
1355
 
# File 'proto_docs/google/cloud/vmmigration/v1/vmmigration.rb', line 1322

class UtilizationReport
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # Utilization report state.
  module State
    # The state is unknown. This value is not in use.
    STATE_UNSPECIFIED = 0

    # The report is in the making.
    CREATING = 1

    # Report creation completed successfully.
    SUCCEEDED = 2

    # Report creation failed.
    FAILED = 3
  end

  # Report time frame options.
  module TimeFrame
    # The time frame was not specified and will default to WEEK.
    TIME_FRAME_UNSPECIFIED = 0

    # One week.
    WEEK = 1

    # One month.
    MONTH = 2

    # One year.
    YEAR = 3
  end
end

#error ⇒ ::Google::Rpc::Status (readonly)

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

Returns:

  • (::Google::Rpc::Status) —

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



1322
1323
1324
1325
1326
1327
1328
1329
1330
1331
1332
1333
1334
1335
1336
1337
1338
1339
1340
1341
1342
1343
1344
1345
1346
1347
1348
1349
1350
1351
1352
1353
1354
1355
 
# File 'proto_docs/google/cloud/vmmigration/v1/vmmigration.rb', line 1322

class UtilizationReport
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # Utilization report state.
  module State
    # The state is unknown. This value is not in use.
    STATE_UNSPECIFIED = 0

    # The report is in the making.
    CREATING = 1

    # Report creation completed successfully.
    SUCCEEDED = 2

    # Report creation failed.
    FAILED = 3
  end

  # Report time frame options.
  module TimeFrame
    # The time frame was not specified and will default to WEEK.
    TIME_FRAME_UNSPECIFIED = 0

    # One week.
    WEEK = 1

    # One month.
    MONTH = 2

    # One year.
    YEAR = 3
  end
end

#frame_end_time ⇒ ::Google::Protobuf::Timestamp (readonly)

Returns 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:

  • (::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.



1322
1323
1324
1325
1326
1327
1328
1329
1330
1331
1332
1333
1334
1335
1336
1337
1338
1339
1340
1341
1342
1343
1344
1345
1346
1347
1348
1349
1350
1351
1352
1353
1354
1355
 
# File 'proto_docs/google/cloud/vmmigration/v1/vmmigration.rb', line 1322

class UtilizationReport
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # Utilization report state.
  module State
    # The state is unknown. This value is not in use.
    STATE_UNSPECIFIED = 0

    # The report is in the making.
    CREATING = 1

    # Report creation completed successfully.
    SUCCEEDED = 2

    # Report creation failed.
    FAILED = 3
  end

  # Report time frame options.
  module TimeFrame
    # The time frame was not specified and will default to WEEK.
    TIME_FRAME_UNSPECIFIED = 0

    # One week.
    WEEK = 1

    # One month.
    MONTH = 2

    # One year.
    YEAR = 3
  end
end

#name ⇒ ::String (readonly)

Returns Output only. The report unique name.

Returns:

  • (::String) —

    Output only. The report unique name.



1322
1323
1324
1325
1326
1327
1328
1329
1330
1331
1332
1333
1334
1335
1336
1337
1338
1339
1340
1341
1342
1343
1344
1345
1346
1347
1348
1349
1350
1351
1352
1353
1354
1355
 
# File 'proto_docs/google/cloud/vmmigration/v1/vmmigration.rb', line 1322

class UtilizationReport
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # Utilization report state.
  module State
    # The state is unknown. This value is not in use.
    STATE_UNSPECIFIED = 0

    # The report is in the making.
    CREATING = 1

    # Report creation completed successfully.
    SUCCEEDED = 2

    # Report creation failed.
    FAILED = 3
  end

  # Report time frame options.
  module TimeFrame
    # The time frame was not specified and will default to WEEK.
    TIME_FRAME_UNSPECIFIED = 0

    # One week.
    WEEK = 1

    # One month.
    MONTH = 2

    # One year.
    YEAR = 3
  end
end

#state ⇒ ::Google::Cloud::VMMigration::V1::UtilizationReport::State (readonly)

Returns Output only. Current state of the report.

Returns:



1322
1323
1324
1325
1326
1327
1328
1329
1330
1331
1332
1333
1334
1335
1336
1337
1338
1339
1340
1341
1342
1343
1344
1345
1346
1347
1348
1349
1350
1351
1352
1353
1354
1355
 
# File 'proto_docs/google/cloud/vmmigration/v1/vmmigration.rb', line 1322

class UtilizationReport
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # Utilization report state.
  module State
    # The state is unknown. This value is not in use.
    STATE_UNSPECIFIED = 0

    # The report is in the making.
    CREATING = 1

    # Report creation completed successfully.
    SUCCEEDED = 2

    # Report creation failed.
    FAILED = 3
  end

  # Report time frame options.
  module TimeFrame
    # The time frame was not specified and will default to WEEK.
    TIME_FRAME_UNSPECIFIED = 0

    # One week.
    WEEK = 1

    # One month.
    MONTH = 2

    # One year.
    YEAR = 3
  end
end

#state_time ⇒ ::Google::Protobuf::Timestamp (readonly)

Returns Output only. The time the state was last set.

Returns:



1322
1323
1324
1325
1326
1327
1328
1329
1330
1331
1332
1333
1334
1335
1336
1337
1338
1339
1340
1341
1342
1343
1344
1345
1346
1347
1348
1349
1350
1351
1352
1353
1354
1355
 
# File 'proto_docs/google/cloud/vmmigration/v1/vmmigration.rb', line 1322

class UtilizationReport
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # Utilization report state.
  module State
    # The state is unknown. This value is not in use.
    STATE_UNSPECIFIED = 0

    # The report is in the making.
    CREATING = 1

    # Report creation completed successfully.
    SUCCEEDED = 2

    # Report creation failed.
    FAILED = 3
  end

  # Report time frame options.
  module TimeFrame
    # The time frame was not specified and will default to WEEK.
    TIME_FRAME_UNSPECIFIED = 0

    # One week.
    WEEK = 1

    # One month.
    MONTH = 2

    # One year.
    YEAR = 3
  end
end

#time_frame ⇒ ::Google::Cloud::VMMigration::V1::UtilizationReport::TimeFrame

Returns Time frame of the report.

Returns:



1322
1323
1324
1325
1326
1327
1328
1329
1330
1331
1332
1333
1334
1335
1336
1337
1338
1339
1340
1341
1342
1343
1344
1345
1346
1347
1348
1349
1350
1351
1352
1353
1354
1355
 
# File 'proto_docs/google/cloud/vmmigration/v1/vmmigration.rb', line 1322

class UtilizationReport
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # Utilization report state.
  module State
    # The state is unknown. This value is not in use.
    STATE_UNSPECIFIED = 0

    # The report is in the making.
    CREATING = 1

    # Report creation completed successfully.
    SUCCEEDED = 2

    # Report creation failed.
    FAILED = 3
  end

  # Report time frame options.
  module TimeFrame
    # The time frame was not specified and will default to WEEK.
    TIME_FRAME_UNSPECIFIED = 0

    # One week.
    WEEK = 1

    # One month.
    MONTH = 2

    # One year.
    YEAR = 3
  end
end

#vm_count ⇒ ::Integer (readonly)

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

Returns:

  • (::Integer) —

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



1322
1323
1324
1325
1326
1327
1328
1329
1330
1331
1332
1333
1334
1335
1336
1337
1338
1339
1340
1341
1342
1343
1344
1345
1346
1347
1348
1349
1350
1351
1352
1353
1354
1355
 
# File 'proto_docs/google/cloud/vmmigration/v1/vmmigration.rb', line 1322

class UtilizationReport
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # Utilization report state.
  module State
    # The state is unknown. This value is not in use.
    STATE_UNSPECIFIED = 0

    # The report is in the making.
    CREATING = 1

    # Report creation completed successfully.
    SUCCEEDED = 2

    # Report creation failed.
    FAILED = 3
  end

  # Report time frame options.
  module TimeFrame
    # The time frame was not specified and will default to WEEK.
    TIME_FRAME_UNSPECIFIED = 0

    # One week.
    WEEK = 1

    # One month.
    MONTH = 2

    # One year.
    YEAR = 3
  end
end

#vms ⇒ ::Array<::Google::Cloud::VMMigration::V1::VmUtilizationInfo>

Returns 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:

  • (::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.



1322
1323
1324
1325
1326
1327
1328
1329
1330
1331
1332
1333
1334
1335
1336
1337
1338
1339
1340
1341
1342
1343
1344
1345
1346
1347
1348
1349
1350
1351
1352
1353
1354
1355
 
# File 'proto_docs/google/cloud/vmmigration/v1/vmmigration.rb', line 1322

class UtilizationReport
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # Utilization report state.
  module State
    # The state is unknown. This value is not in use.
    STATE_UNSPECIFIED = 0

    # The report is in the making.
    CREATING = 1

    # Report creation completed successfully.
    SUCCEEDED = 2

    # Report creation failed.
    FAILED = 3
  end

  # Report time frame options.
  module TimeFrame
    # The time frame was not specified and will default to WEEK.
    TIME_FRAME_UNSPECIFIED = 0

    # One week.
    WEEK = 1

    # One month.
    MONTH = 2

    # One year.
    YEAR = 3
  end
end