# Google Cloud Data Catalog V1 Client - Class UsageSignal (2.4.2)

2.4.2 (latest) 2.4.1 2.3.2 2.2.4 2.1.0 2.0.2 1.10.3 1.9.1 1.8.2 1.7.1 1.6.0 1.5.1 1.4.2 1.3.9 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`

## Namespace

Google \\ Cloud \\ DataCatalog \\ V1

## Methods

### __construct

Constructor.

| **Parameters** ||
|---|---|
| **Name** | **Description** |
| `data` | `array` Optional. Data for populating the Message object. |
| `↳ update_time` | `https://protobuf.dev/reference/php/api-docs/Google/Protobuf/Timestamp` The end timestamp of the duration of usage statistics. |
| `↳ usage_within_time_range` | `array|https://protobuf.dev/reference/php/api-docs/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|https://protobuf.dev/reference/php/api-docs/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** ||
|---|---|
| **Type** | **Description** |
| `https://protobuf.dev/reference/php/api-docs/Google/Protobuf/Timestamp|null` |   |

### hasUpdateTime

### clearUpdateTime

### setUpdateTime

The end timestamp of the duration of usage statistics.

| **Parameter** ||
|---|---|
| **Name** | **Description** |
| `var` | `https://protobuf.dev/reference/php/api-docs/Google/Protobuf/Timestamp` |

| **Returns** ||
|---|---|
| **Type** | **Description** |
| `$this` |   |

### getUsageWithinTimeRange

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

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

| **Returns** ||
|---|---|
| **Type** | **Description** |
| `https://protobuf.dev/reference/php/api-docs/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** ||
|---|---|
| **Name** | **Description** |
| `var` | `array|https://protobuf.dev/reference/php/api-docs/Google/Protobuf/Internal/MapField` |

| **Returns** ||
|---|---|
| **Type** | **Description** |
| `$this` |   |

### getCommonUsageWithinTimeRange

Common usage statistics over each of the predefined time ranges.

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

| **Returns** ||
|---|---|
| **Type** | **Description** |
| `https://protobuf.dev/reference/php/api-docs/Google/Protobuf/Internal/MapField` |   |

### setCommonUsageWithinTimeRange

Common usage statistics over each of the predefined time ranges.

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

| **Parameter** ||
|---|---|
| **Name** | **Description** |
| `var` | `array|https://protobuf.dev/reference/php/api-docs/Google/Protobuf/Internal/MapField` |

| **Returns** ||
|---|---|
| **Type** | **Description** |
| `$this` |   |

### getFavoriteCount

Favorite count in the source system.

| **Returns** ||
|---|---|
| **Type** | **Description** |
| `int|string` |   |

### hasFavoriteCount

### clearFavoriteCount

### setFavoriteCount

Favorite count in the source system.

| **Parameter** ||
|---|---|
| **Name** | **Description** |
| `var` | `int|string` |

| **Returns** ||
|---|---|
| **Type** | **Description** |
| `$this` |   |