- Resource: MigrationSubtask
- State
- ResourceErrorDetail
- ResourceInfo
- ErrorDetail
- ErrorLocation
- TimeSeries
- ValueType
- MetricKind
- Point
- TimeInterval
- TypedValue
- Distribution
- Range
- BucketOptions
- Linear
- Exponential
- Explicit
- Exemplar
- Methods
Resource: MigrationSubtask
A subtask for a migration which carries details about the configuration of the subtask. The content of the details should not matter to the end user, but is a contract between the subtask creator and subtask worker.
JSON representation | |
---|---|
{ "name": string, "taskId": string, "type": string, "state": enum ( |
Fields | |
---|---|
name |
Output only. Immutable. The resource name for the migration subtask. The ID is server-generated. Example: |
taskId |
The unique ID of the task to which this subtask belongs. |
type |
The type of the Subtask. The migration service does not check whether this is a known type. It is up to the task creator (i.e. orchestrator or worker) to ensure it only creates subtasks for which there are compatible workers polling for Subtasks. |
state |
Output only. The current state of the subtask. |
processingError |
Output only. An explanation that may be populated when the task is in FAILED state. |
resourceErrorDetails[] |
Output only. Provides details to errors and issues encountered while processing the subtask. Presence of error details does not mean that the subtask failed. |
resourceErrorCount |
The number or resources with errors. Note: This is not the total number of errors as each resource can have more than one error. This is used to indicate truncation by having a |
createTime |
Time when the subtask was created. |
lastUpdateTime |
Time when the subtask was last updated. |
metrics[] |
The metrics for the subtask. |
State
Possible states of a migration subtask.
Enums | |
---|---|
STATE_UNSPECIFIED |
The state is unspecified. |
ACTIVE |
The subtask is ready, i.e. it is ready for execution. |
RUNNING |
The subtask is running, i.e. it is assigned to a worker for execution. |
SUCCEEDED |
The subtask finished successfully. |
FAILED |
The subtask finished unsuccessfully. |
PAUSED |
The subtask is paused, i.e., it will not be scheduled. If it was already assigned,it might still finish but no new lease renewals will be granted. |
ResourceErrorDetail
Provides details for errors and the corresponding resources.
JSON representation | |
---|---|
{ "resourceInfo": { object ( |
Fields | |
---|---|
resourceInfo |
Required. Information about the resource where the error is located. |
errorDetails[] |
Required. The error details for the resource. |
errorCount |
Required. How many errors there are in total for the resource. Truncation can be indicated by having an |
ResourceInfo
Describes the resource that is being accessed.
JSON representation | |
---|---|
{ "resourceType": string, "resourceName": string, "owner": string, "description": string } |
Fields | |
---|---|
resourceType |
A name for the type of resource being accessed, e.g. "sql table", "cloud storage bucket", "file", "Google calendar"; or the type URL of the resource: e.g. "type.googleapis.com/google.pubsub.v1.Topic". |
resourceName |
The name of the resource being accessed. For example, a shared calendar name: "example.com_4fghdhgsrgh@group.calendar.google.com", if the current error is |
owner |
The owner of the resource (optional). For example, "user: |
description |
Describes what error is encountered when accessing this resource. For example, updating a cloud project may require the |
ErrorDetail
Provides details for errors, e.g. issues that where encountered when processing a subtask.
JSON representation | |
---|---|
{ "location": { object ( |
Fields | |
---|---|
location |
Optional. The exact location within the resource (if applicable). |
errorInfo |
Required. Describes the cause of the error with structured detail. |
ErrorLocation
Holds information about where the error is located.
JSON representation | |
---|---|
{ "line": integer, "column": integer } |
Fields | |
---|---|
line |
Optional. If applicable, denotes the line where the error occurred. A zero value means that there is no line information. |
column |
Optional. If applicable, denotes the column where the error occurred. A zero value means that there is no columns information. |
TimeSeries
The metrics object for a SubTask.
JSON representation | |
---|---|
{ "metric": string, "valueType": enum ( |
Fields | |
---|---|
metric |
Required. The name of the metric. If the metric is not known by the service yet, it will be auto-created. |
valueType |
Required. The value type of the time series. |
metricKind |
Optional. The metric kind of the time series. If present, it must be the same as the metric kind of the associated metric. If the associated metric's descriptor must be auto-created, then this field specifies the metric kind of the new descriptor and must be either |
points[] |
Required. The data points of this time series. When listing time series, points are returned in reverse time order. When creating a time series, this field must contain exactly one point and the point's type must be the same as the value type of the associated metric. If the associated metric's descriptor must be auto-created, then the value type of the descriptor is determined by the point's type, which must be |
ValueType
The value type of a metric.
Enums | |
---|---|
VALUE_TYPE_UNSPECIFIED |
Do not use this default value. |
BOOL |
The value is a boolean. This value type can be used only if the metric kind is GAUGE . |
INT64 |
The value is a signed 64-bit integer. |
DOUBLE |
The value is a double precision floating point number. |
STRING |
The value is a text string. This value type can be used only if the metric kind is GAUGE . |
DISTRIBUTION |
The value is a . |
MONEY |
The value is money. |
MetricKind
The kind of measurement. It describes how the data is reported. For information on setting the start time and end time based on the MetricKind, see [TimeInterval][google.monitoring.v3.TimeInterval].
Enums | |
---|---|
METRIC_KIND_UNSPECIFIED |
Do not use this default value. |
GAUGE |
An instantaneous measurement of a value. |
DELTA |
The change in a value during a time interval. |
CUMULATIVE |
A value accumulated over a time interval. Cumulative measurements in a time series should have the same start time and increasing end times, until an event resets the cumulative value to zero and sets a new start time for the following points. |
Point
A single data point in a time series.
JSON representation | |
---|---|
{ "interval": { object ( |
Fields | |
---|---|
interval |
The time interval to which the data point applies. For |
value |
The value of the data point. |
TimeInterval
A time interval extending just after a start time through an end time. If the start time is the same as the end time, then the interval represents a single point in time.
JSON representation | |
---|---|
{ "startTime": string, "endTime": string } |
Fields | |
---|---|
startTime |
Optional. The beginning of the time interval. The default value for the start time is the end time. The start time must not be later than the end time. |
endTime |
Required. The end of the time interval. |
TypedValue
A single strongly-typed value.
JSON representation | |
---|---|
{ // Union field |
Fields | ||
---|---|---|
Union field value . The typed value field. value can be only one of the following: |
||
boolValue |
A Boolean value: |
|
int64Value |
A 64-bit integer. Its range is approximately +/-9.2x10^18. |
|
doubleValue |
A 64-bit double-precision floating-point number. Its magnitude is approximately +/-10^(+/-300) and it has 16 significant digits of precision. |
|
stringValue |
A variable-length string value. |
|
distributionValue |
A distribution value. |
Distribution
Distribution
contains summary statistics for a population of values. It optionally contains a histogram representing the distribution of those values across a set of buckets.
The summary statistics are the count, mean, sum of the squared deviation from the mean, the minimum, and the maximum of the set of population of values. The histogram is based on a sequence of buckets and gives a count of values that fall into each bucket. The boundaries of the buckets are given either explicitly or by formulas for buckets of fixed or exponentially increasing widths.
Although it is not forbidden, it is generally a bad idea to include non-finite values (infinities or NaNs) in the population of values, as this will render the mean
and sumOfSquaredDeviation
fields meaningless.
JSON representation | |
---|---|
{ "count": string, "mean": number, "sumOfSquaredDeviation": number, "range": { object ( |
Fields | |
---|---|
count |
The number of values in the population. Must be non-negative. This value must equal the sum of the values in |
mean |
The arithmetic mean of the values in the population. If |
sumOfSquaredDeviation |
The sum of squared deviations from the mean of the values in the population. For values x_i this is:
Knuth, "The Art of Computer Programming", Vol. 2, page 232, 3rd edition describes Welford's method for accumulating this sum in one pass. If |
range |
If specified, contains the range of the population values. The field must not be present if the |
bucketOptions |
Defines the histogram bucket boundaries. If the distribution does not contain a histogram, then omit this field. |
bucketCounts[] |
The number of values in each bucket of the histogram, as described in If present, The order of the values in |
exemplars[] |
Must be in increasing order of |
Range
The range of the population values.
JSON representation | |
---|---|
{ "min": number, "max": number } |
Fields | |
---|---|
min |
The minimum of the population values. |
max |
The maximum of the population values. |
BucketOptions
BucketOptions
describes the bucket boundaries used to create a histogram for the distribution. The buckets can be in a linear sequence, an exponential sequence, or each bucket can be specified explicitly. BucketOptions
does not include the number of values in each bucket.
A bucket has an inclusive lower bound and exclusive upper bound for the values that are counted for that bucket. The upper bound of a bucket must be strictly greater than the lower bound. The sequence of N buckets for a distribution consists of an underflow bucket (number 0), zero or more finite buckets (number 1 through N - 2) and an overflow bucket (number N - 1). The buckets are contiguous: the lower bound of bucket i (i > 0) is the same as the upper bound of bucket i - 1. The buckets span the whole range of finite values: lower bound of the underflow bucket is -infinity and the upper bound of the overflow bucket is +infinity. The finite buckets are so-called because both bounds are finite.
JSON representation | |
---|---|
{ // Union field |
Fields | ||
---|---|---|
Union field options . Exactly one of these three fields must be set. options can be only one of the following: |
||
linearBuckets |
The linear bucket. |
|
exponentialBuckets |
The exponential buckets. |
|
explicitBuckets |
The explicit buckets. |
Linear
Specifies a linear sequence of buckets that all have the same width (except overflow and underflow). Each bucket represents a constant absolute uncertainty on the specific value in the bucket.
There are numFiniteBuckets + 2
(= N) buckets. Bucket i
has the following boundaries:
Upper bound (0 <= i < N-1): offset + (width * i). Lower bound (1 <= i < N): offset + (width * (i - 1)).
JSON representation | |
---|---|
{ "numFiniteBuckets": integer, "width": number, "offset": number } |
Fields | |
---|---|
numFiniteBuckets |
Must be greater than 0. |
width |
Must be greater than 0. |
offset |
Lower bound of the first bucket. |
Exponential
Specifies an exponential sequence of buckets that have a width that is proportional to the value of the lower bound. Each bucket represents a constant relative uncertainty on a specific value in the bucket.
There are numFiniteBuckets + 2
(= N) buckets. Bucket i
has the following boundaries:
Upper bound (0 <= i < N-1): scale * (growthFactor ^ i). Lower bound (1 <= i < N): scale * (growthFactor ^ (i - 1)).
JSON representation | |
---|---|
{ "numFiniteBuckets": integer, "growthFactor": number, "scale": number } |
Fields | |
---|---|
numFiniteBuckets |
Must be greater than 0. |
growthFactor |
Must be greater than 1. |
scale |
Must be greater than 0. |
Explicit
Specifies a set of buckets with arbitrary widths.
There are size(bounds) + 1
(= N) buckets. Bucket i
has the following boundaries:
Upper bound (0 <= i < N-1): bounds[i] Lower bound (1 <= i < N); bounds[i - 1]
The bounds
field must contain at least one element. If bounds
has only one element, then there are no finite buckets, and that single element is the common boundary of the overflow and underflow buckets.
JSON representation | |
---|---|
{ "bounds": [ number ] } |
Fields | |
---|---|
bounds[] |
The values must be monotonically increasing. |
Exemplar
Exemplars are example points that may be used to annotate aggregated distribution values. They are metadata that gives information about a particular value added to a Distribution bucket, such as a trace ID that was active when a value was added. They may contain further information, such as a example values and timestamps, origin, etc.
JSON representation | |
---|---|
{ "value": number, "timestamp": string, "attachments": [ { "@type": string, field1: ..., ... } ] } |
Fields | |
---|---|
value |
Value of the exemplar point. This value determines to which bucket the exemplar belongs. |
timestamp |
The observation (sampling) time of the above value. |
attachments[] |
Contextual information about the example value. Examples are: Trace: type.googleapis.com/google.monitoring.v3.SpanContext Literal string: type.googleapis.com/google.protobuf.StringValue Labels dropped during aggregation: type.googleapis.com/google.monitoring.v3.DroppedLabels There may be only a single attachment of any given message type in a single exemplar, and this is enforced by the system. |
Methods |
|
---|---|
|
Gets a previously created migration subtask. |
|
Lists previously created migration subtasks. |