Close httplib2 connections.
create(parent, body=None, requestId=None, utilizationReportId=None, x__xgafv=None)
Creates a new UtilizationReport.
delete(name, requestId=None, x__xgafv=None)
Deletes a single Utilization Report.
get(name, view=None, x__xgafv=None)
Gets a single Utilization Report.
list(parent, filter=None, orderBy=None, pageSize=None, pageToken=None, view=None, x__xgafv=None)
Lists Utilization Reports of the given Source.
list_next(previous_request, previous_response)
Retrieves the next page of results.
close()
Close httplib2 connections.
create(parent, body=None, requestId=None, utilizationReportId=None, x__xgafv=None)
Creates a new UtilizationReport.
Args:
parent: string, Required. The Utilization Report's parent. (required)
body: object, The request body.
The object takes the form of:
{ # Utilization report details the utilization (CPU, memory, etc.) of selected source VMs.
"createTime": "A String", # Output only. The time the report was created (this refers to the time of the request, not the time the report creation completed).
"displayName": "A String", # The report display name, as assigned by the user.
"error": { # The `Status` type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by [gRPC](https://github.com/grpc). Each `Status` message contains three pieces of data: error code, error message, and error details. You can find out more about this error model and how to work with it in the [API Design Guide](https://cloud.google.com/apis/design/errors). # Output only. Provides details on the state of the report in case of an error.
"code": 42, # The status code, which should be an enum value of google.rpc.Code.
"details": [ # A list of messages that carry the error details. There is a common set of message types for APIs to use.
{
"a_key": "", # Properties of the object. Contains field @type with type URL.
},
],
"message": "A String", # A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client.
},
"frameEndTime": "A String", # 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.
"name": "A String", # Output only. The report unique name.
"state": "A String", # Output only. Current state of the report.
"stateTime": "A String", # Output only. The time the state was last set.
"timeFrame": "A String", # Time frame of the report.
"vmCount": 42, # Output only. Total number of VMs included in the report.
"vms": [ # 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.
{ # Utilization information of a single VM.
"utilization": { # Utilization metrics values for a single VM. # Utilization metrics for this VM.
"cpuAveragePercent": 42, # Average CPU usage, percent.
"cpuMaxPercent": 42, # Max CPU usage, percent.
"diskIoRateAverageKbps": "A String", # Average disk IO rate, in kilobytes per second.
"diskIoRateMaxKbps": "A String", # Max disk IO rate, in kilobytes per second.
"memoryAveragePercent": 42, # Average memory usage, percent.
"memoryMaxPercent": 42, # Max memory usage, percent.
"networkThroughputAverageKbps": "A String", # Average network throughput (combined transmit-rates and receive-rates), in kilobytes per second.
"networkThroughputMaxKbps": "A String", # Max network throughput (combined transmit-rates and receive-rates), in kilobytes per second.
},
"vmId": "A String", # The VM's ID in the source.
"vmwareVmDetails": { # VmwareVmDetails describes a VM in vCenter. # The description of the VM in a Source of type Vmware.
"bootOption": "A String", # Output only. The VM Boot Option.
"committedStorageMb": "A String", # The total size of the storage allocated to the VM in MB.
"cpuCount": 42, # The number of cpus in the VM.
"datacenterDescription": "A String", # The descriptive name of the vCenter's datacenter this VM is contained in.
"datacenterId": "A String", # The id of the vCenter's datacenter this VM is contained in.
"diskCount": 42, # The number of disks the VM has.
"displayName": "A String", # The display name of the VM. Note that this is not necessarily unique.
"guestDescription": "A String", # The VM's OS. See for example https://pubs.vmware.com/vi-sdk/visdk250/ReferenceGuide/vim.vm.GuestOsDescriptor.GuestOsIdentifier.html for types of strings this might hold.
"memoryMb": 42, # The size of the memory of the VM in MB.
"powerState": "A String", # The power state of the VM at the moment list was taken.
"uuid": "A String", # The unique identifier of the VM in vCenter.
"vmId": "A String", # The VM's id in the source (note that this is not the MigratingVm's id). This is the moref id of the VM.
},
},
],
}
requestId: string, A request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. The server will guarantee that for at least 60 minutes since the first request. For example, consider a situation where you make an initial request and t he request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000).
utilizationReportId: string, Required. The ID to use for the report, which will become the final component of the reports's resource name. This value maximum length is 63 characters, and valid characters are /a-z-/. It must start with an english letter and must not end with a hyphen.
x__xgafv: string, V1 error format.
Allowed values
1 - v1 error format
2 - v2 error format
Returns:
An object of the form:
{ # This resource represents a long-running operation that is the result of a network API call.
"done": True or False, # If the value is `false`, it means the operation is still in progress. If `true`, the operation is completed, and either `error` or `response` is available.
"error": { # The `Status` type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by [gRPC](https://github.com/grpc). Each `Status` message contains three pieces of data: error code, error message, and error details. You can find out more about this error model and how to work with it in the [API Design Guide](https://cloud.google.com/apis/design/errors). # The error result of the operation in case of failure or cancellation.
"code": 42, # The status code, which should be an enum value of google.rpc.Code.
"details": [ # A list of messages that carry the error details. There is a common set of message types for APIs to use.
{
"a_key": "", # Properties of the object. Contains field @type with type URL.
},
],
"message": "A String", # A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client.
},
"metadata": { # Service-specific metadata associated with the operation. It typically contains progress information and common metadata such as create time. Some services might not provide such metadata. Any method that returns a long-running operation should document the metadata type, if any.
"a_key": "", # Properties of the object. Contains field @type with type URL.
},
"name": "A String", # The server-assigned name, which is only unique within the same service that originally returns it. If you use the default HTTP mapping, the `name` should be a resource name ending with `operations/{unique_id}`.
"response": { # The normal response of the operation in case of success. If the original method returns no data on success, such as `Delete`, the response is `google.protobuf.Empty`. If the original method is standard `Get`/`Create`/`Update`, the response should be the resource. For other methods, the response should have the type `XxxResponse`, where `Xxx` is the original method name. For example, if the original method name is `TakeSnapshot()`, the inferred response type is `TakeSnapshotResponse`.
"a_key": "", # Properties of the object. Contains field @type with type URL.
},
}
delete(name, requestId=None, x__xgafv=None)
Deletes a single Utilization Report.
Args:
name: string, Required. The Utilization Report name. (required)
requestId: string, Optional. A request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. The server will guarantee that for at least 60 minutes after the first request. For example, consider a situation where you make an initial request and t he request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000).
x__xgafv: string, V1 error format.
Allowed values
1 - v1 error format
2 - v2 error format
Returns:
An object of the form:
{ # This resource represents a long-running operation that is the result of a network API call.
"done": True or False, # If the value is `false`, it means the operation is still in progress. If `true`, the operation is completed, and either `error` or `response` is available.
"error": { # The `Status` type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by [gRPC](https://github.com/grpc). Each `Status` message contains three pieces of data: error code, error message, and error details. You can find out more about this error model and how to work with it in the [API Design Guide](https://cloud.google.com/apis/design/errors). # The error result of the operation in case of failure or cancellation.
"code": 42, # The status code, which should be an enum value of google.rpc.Code.
"details": [ # A list of messages that carry the error details. There is a common set of message types for APIs to use.
{
"a_key": "", # Properties of the object. Contains field @type with type URL.
},
],
"message": "A String", # A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client.
},
"metadata": { # Service-specific metadata associated with the operation. It typically contains progress information and common metadata such as create time. Some services might not provide such metadata. Any method that returns a long-running operation should document the metadata type, if any.
"a_key": "", # Properties of the object. Contains field @type with type URL.
},
"name": "A String", # The server-assigned name, which is only unique within the same service that originally returns it. If you use the default HTTP mapping, the `name` should be a resource name ending with `operations/{unique_id}`.
"response": { # The normal response of the operation in case of success. If the original method returns no data on success, such as `Delete`, the response is `google.protobuf.Empty`. If the original method is standard `Get`/`Create`/`Update`, the response should be the resource. For other methods, the response should have the type `XxxResponse`, where `Xxx` is the original method name. For example, if the original method name is `TakeSnapshot()`, the inferred response type is `TakeSnapshotResponse`.
"a_key": "", # Properties of the object. Contains field @type with type URL.
},
}
get(name, view=None, x__xgafv=None)
Gets a single Utilization Report.
Args:
name: string, Required. The Utilization Report name. (required)
view: string, Optional. The level of details of the report. Defaults to FULL
Allowed values
UTILIZATION_REPORT_VIEW_UNSPECIFIED - The default / unset value. The API will default to FULL on single report request and BASIC for multiple reports request.
BASIC - Get the report metadata, without the list of VMs and their utilization info.
FULL - Include everything.
x__xgafv: string, V1 error format.
Allowed values
1 - v1 error format
2 - v2 error format
Returns:
An object of the form:
{ # Utilization report details the utilization (CPU, memory, etc.) of selected source VMs.
"createTime": "A String", # Output only. The time the report was created (this refers to the time of the request, not the time the report creation completed).
"displayName": "A String", # The report display name, as assigned by the user.
"error": { # The `Status` type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by [gRPC](https://github.com/grpc). Each `Status` message contains three pieces of data: error code, error message, and error details. You can find out more about this error model and how to work with it in the [API Design Guide](https://cloud.google.com/apis/design/errors). # Output only. Provides details on the state of the report in case of an error.
"code": 42, # The status code, which should be an enum value of google.rpc.Code.
"details": [ # A list of messages that carry the error details. There is a common set of message types for APIs to use.
{
"a_key": "", # Properties of the object. Contains field @type with type URL.
},
],
"message": "A String", # A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client.
},
"frameEndTime": "A String", # 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.
"name": "A String", # Output only. The report unique name.
"state": "A String", # Output only. Current state of the report.
"stateTime": "A String", # Output only. The time the state was last set.
"timeFrame": "A String", # Time frame of the report.
"vmCount": 42, # Output only. Total number of VMs included in the report.
"vms": [ # 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.
{ # Utilization information of a single VM.
"utilization": { # Utilization metrics values for a single VM. # Utilization metrics for this VM.
"cpuAveragePercent": 42, # Average CPU usage, percent.
"cpuMaxPercent": 42, # Max CPU usage, percent.
"diskIoRateAverageKbps": "A String", # Average disk IO rate, in kilobytes per second.
"diskIoRateMaxKbps": "A String", # Max disk IO rate, in kilobytes per second.
"memoryAveragePercent": 42, # Average memory usage, percent.
"memoryMaxPercent": 42, # Max memory usage, percent.
"networkThroughputAverageKbps": "A String", # Average network throughput (combined transmit-rates and receive-rates), in kilobytes per second.
"networkThroughputMaxKbps": "A String", # Max network throughput (combined transmit-rates and receive-rates), in kilobytes per second.
},
"vmId": "A String", # The VM's ID in the source.
"vmwareVmDetails": { # VmwareVmDetails describes a VM in vCenter. # The description of the VM in a Source of type Vmware.
"bootOption": "A String", # Output only. The VM Boot Option.
"committedStorageMb": "A String", # The total size of the storage allocated to the VM in MB.
"cpuCount": 42, # The number of cpus in the VM.
"datacenterDescription": "A String", # The descriptive name of the vCenter's datacenter this VM is contained in.
"datacenterId": "A String", # The id of the vCenter's datacenter this VM is contained in.
"diskCount": 42, # The number of disks the VM has.
"displayName": "A String", # The display name of the VM. Note that this is not necessarily unique.
"guestDescription": "A String", # The VM's OS. See for example https://pubs.vmware.com/vi-sdk/visdk250/ReferenceGuide/vim.vm.GuestOsDescriptor.GuestOsIdentifier.html for types of strings this might hold.
"memoryMb": 42, # The size of the memory of the VM in MB.
"powerState": "A String", # The power state of the VM at the moment list was taken.
"uuid": "A String", # The unique identifier of the VM in vCenter.
"vmId": "A String", # The VM's id in the source (note that this is not the MigratingVm's id). This is the moref id of the VM.
},
},
],
}
list(parent, filter=None, orderBy=None, pageSize=None, pageToken=None, view=None, x__xgafv=None)
Lists Utilization Reports of the given Source.
Args:
parent: string, Required. The Utilization Reports parent. (required)
filter: string, Optional. The filter request.
orderBy: string, Optional. the order by fields for the result.
pageSize: integer, Optional. The maximum number of reports to return. The service may return fewer than this value. If unspecified, at most 500 reports will be returned. The maximum value is 1000; values above 1000 will be coerced to 1000.
pageToken: string, Required. A page token, received from a previous `ListUtilizationReports` call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to `ListUtilizationReports` must match the call that provided the page token.
view: string, Optional. The level of details of each report. Defaults to BASIC.
Allowed values
UTILIZATION_REPORT_VIEW_UNSPECIFIED - The default / unset value. The API will default to FULL on single report request and BASIC for multiple reports request.
BASIC - Get the report metadata, without the list of VMs and their utilization info.
FULL - Include everything.
x__xgafv: string, V1 error format.
Allowed values
1 - v1 error format
2 - v2 error format
Returns:
An object of the form:
{ # Response message for 'ListUtilizationReports' request.
"nextPageToken": "A String", # Output only. A token, which can be sent as `page_token` to retrieve the next page. If this field is omitted, there are no subsequent pages.
"unreachable": [ # Output only. Locations that could not be reached.
"A String",
],
"utilizationReports": [ # Output only. The list of reports.
{ # Utilization report details the utilization (CPU, memory, etc.) of selected source VMs.
"createTime": "A String", # Output only. The time the report was created (this refers to the time of the request, not the time the report creation completed).
"displayName": "A String", # The report display name, as assigned by the user.
"error": { # The `Status` type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by [gRPC](https://github.com/grpc). Each `Status` message contains three pieces of data: error code, error message, and error details. You can find out more about this error model and how to work with it in the [API Design Guide](https://cloud.google.com/apis/design/errors). # Output only. Provides details on the state of the report in case of an error.
"code": 42, # The status code, which should be an enum value of google.rpc.Code.
"details": [ # A list of messages that carry the error details. There is a common set of message types for APIs to use.
{
"a_key": "", # Properties of the object. Contains field @type with type URL.
},
],
"message": "A String", # A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client.
},
"frameEndTime": "A String", # 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.
"name": "A String", # Output only. The report unique name.
"state": "A String", # Output only. Current state of the report.
"stateTime": "A String", # Output only. The time the state was last set.
"timeFrame": "A String", # Time frame of the report.
"vmCount": 42, # Output only. Total number of VMs included in the report.
"vms": [ # 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.
{ # Utilization information of a single VM.
"utilization": { # Utilization metrics values for a single VM. # Utilization metrics for this VM.
"cpuAveragePercent": 42, # Average CPU usage, percent.
"cpuMaxPercent": 42, # Max CPU usage, percent.
"diskIoRateAverageKbps": "A String", # Average disk IO rate, in kilobytes per second.
"diskIoRateMaxKbps": "A String", # Max disk IO rate, in kilobytes per second.
"memoryAveragePercent": 42, # Average memory usage, percent.
"memoryMaxPercent": 42, # Max memory usage, percent.
"networkThroughputAverageKbps": "A String", # Average network throughput (combined transmit-rates and receive-rates), in kilobytes per second.
"networkThroughputMaxKbps": "A String", # Max network throughput (combined transmit-rates and receive-rates), in kilobytes per second.
},
"vmId": "A String", # The VM's ID in the source.
"vmwareVmDetails": { # VmwareVmDetails describes a VM in vCenter. # The description of the VM in a Source of type Vmware.
"bootOption": "A String", # Output only. The VM Boot Option.
"committedStorageMb": "A String", # The total size of the storage allocated to the VM in MB.
"cpuCount": 42, # The number of cpus in the VM.
"datacenterDescription": "A String", # The descriptive name of the vCenter's datacenter this VM is contained in.
"datacenterId": "A String", # The id of the vCenter's datacenter this VM is contained in.
"diskCount": 42, # The number of disks the VM has.
"displayName": "A String", # The display name of the VM. Note that this is not necessarily unique.
"guestDescription": "A String", # The VM's OS. See for example https://pubs.vmware.com/vi-sdk/visdk250/ReferenceGuide/vim.vm.GuestOsDescriptor.GuestOsIdentifier.html for types of strings this might hold.
"memoryMb": 42, # The size of the memory of the VM in MB.
"powerState": "A String", # The power state of the VM at the moment list was taken.
"uuid": "A String", # The unique identifier of the VM in vCenter.
"vmId": "A String", # The VM's id in the source (note that this is not the MigratingVm's id). This is the moref id of the VM.
},
},
],
},
],
}
list_next(previous_request, previous_response)
Retrieves the next page of results.
Args:
previous_request: The request for the previous page. (required)
previous_response: The response from the request for the previous page. (required)
Returns:
A request object that you can call 'execute()' on to request the next
page. Returns None if there are no more items in the collection.