Reference documentation and code samples for the Google Cloud Data Catalog V1 Client class UsageStats.
Detailed statistics on the entry's usage.
Usage statistics have the following limitations:
- Only BigQuery tables have them.
- They only include BigQuery query jobs.
- They might be underestimated because wildcard table references are not yet counted. For more information, see Querying multiple tables using a wildcard table
Generated from protobuf message google.cloud.datacatalog.v1.UsageStats
Methods
__construct
Constructor.
| Parameters | |
|---|---|
| Name | Description |
data |
array
Optional. Data for populating the Message object. |
↳ total_completions |
float
The number of successful uses of the underlying entry. |
↳ total_failures |
float
The number of failed attempts to use the underlying entry. |
↳ total_cancellations |
float
The number of cancelled attempts to use the underlying entry. |
↳ total_execution_time_for_completions_millis |
float
Total time spent only on successful uses, in milliseconds. |
getTotalCompletions
The number of successful uses of the underlying entry.
| Returns | |
|---|---|
| Type | Description |
float | |
setTotalCompletions
The number of successful uses of the underlying entry.
| Parameter | |
|---|---|
| Name | Description |
var |
float
|
| Returns | |
|---|---|
| Type | Description |
$this | |
getTotalFailures
The number of failed attempts to use the underlying entry.
| Returns | |
|---|---|
| Type | Description |
float | |
setTotalFailures
The number of failed attempts to use the underlying entry.
| Parameter | |
|---|---|
| Name | Description |
var |
float
|
| Returns | |
|---|---|
| Type | Description |
$this | |
getTotalCancellations
The number of cancelled attempts to use the underlying entry.
| Returns | |
|---|---|
| Type | Description |
float | |
setTotalCancellations
The number of cancelled attempts to use the underlying entry.
| Parameter | |
|---|---|
| Name | Description |
var |
float
|
| Returns | |
|---|---|
| Type | Description |
$this | |
getTotalExecutionTimeForCompletionsMillis
Total time spent only on successful uses, in milliseconds.
| Returns | |
|---|---|
| Type | Description |
float | |
setTotalExecutionTimeForCompletionsMillis
Total time spent only on successful uses, in milliseconds.
| Parameter | |
|---|---|
| Name | Description |
var |
float
|
| Returns | |
|---|---|
| Type | Description |
$this | |