Google Cloud Data Catalog V1 Client - Class UsageSignal (1.4.2)

Reference documentation and code samples for the Google Cloud Data Catalog V1 Client class UsageSignal.

The set of all usage signals that Data Catalog stores.

Note: Usually, these signals are updated daily. In rare cases, an update may fail but will be performed again on the next day.

Generated from protobuf message google.cloud.datacatalog.v1.UsageSignal

Methods

__construct

Constructor.

Parameters
NameDescription
data array

Optional. Data for populating the Message object.

↳ update_time Google\Protobuf\Timestamp

The end timestamp of the duration of usage statistics.

↳ usage_within_time_range array|Google\Protobuf\Internal\MapField

Output only. BigQuery usage statistics over each of the predefined time ranges. Supported time ranges are {"24H", "7D", "30D"}.

↳ common_usage_within_time_range array|Google\Protobuf\Internal\MapField

Common usage statistics over each of the predefined time ranges. Supported time ranges are {"24H", "7D", "30D", "Lifetime"}.

↳ favorite_count int|string

Favorite count in the source system.

getUpdateTime

The end timestamp of the duration of usage statistics.

Returns
TypeDescription
Google\Protobuf\Timestamp|null

hasUpdateTime

clearUpdateTime

setUpdateTime

The end timestamp of the duration of usage statistics.

Parameter
NameDescription
var Google\Protobuf\Timestamp
Returns
TypeDescription
$this

getUsageWithinTimeRange

Output only. BigQuery usage statistics over each of the predefined time ranges.

Supported time ranges are {"24H", "7D", "30D"}.

Returns
TypeDescription
Google\Protobuf\Internal\MapField

setUsageWithinTimeRange

Output only. BigQuery usage statistics over each of the predefined time ranges.

Supported time ranges are {"24H", "7D", "30D"}.

Parameter
NameDescription
var array|Google\Protobuf\Internal\MapField
Returns
TypeDescription
$this

getCommonUsageWithinTimeRange

Common usage statistics over each of the predefined time ranges.

Supported time ranges are {"24H", "7D", "30D", "Lifetime"}.

Returns
TypeDescription
Google\Protobuf\Internal\MapField

setCommonUsageWithinTimeRange

Common usage statistics over each of the predefined time ranges.

Supported time ranges are {"24H", "7D", "30D", "Lifetime"}.

Parameter
NameDescription
var array|Google\Protobuf\Internal\MapField
Returns
TypeDescription
$this

getFavoriteCount

Favorite count in the source system.

Returns
TypeDescription
int|string

hasFavoriteCount

clearFavoriteCount

setFavoriteCount

Favorite count in the source system.

Parameter
NameDescription
var int|string
Returns
TypeDescription
$this