Stackdriver Logging V2 Client - Class Link (1.31.1)

Reference documentation and code samples for the Stackdriver Logging V2 Client class Link.

Describes a link connected to an analytics enabled bucket.

Generated from protobuf message google.logging.v2.Link

Namespace

Google \ Cloud \ Logging \ V2

Methods

__construct

Constructor.

Parameters
Name	Description
`data`	`array` Optional. Data for populating the Message object.
`↳ name`	`string` The resource name of the link. The name can have up to 100 characters. A valid link id (at the end of the link name) must only have alphanumeric characters and underscores within it. "projects/[PROJECT_ID]/locations/[LOCATION_ID]/buckets/[BUCKET_ID]/links/[LINK_ID]" "organizations/[ORGANIZATION_ID]/locations/[LOCATION_ID]/buckets/[BUCKET_ID]/links/[LINK_ID]" "billingAccounts/[BILLING_ACCOUNT_ID]/locations/[LOCATION_ID]/buckets/[BUCKET_ID]/links/[LINK_ID]" "folders/[FOLDER_ID]/locations/[LOCATION_ID]/buckets/[BUCKET_ID]/links/[LINK_ID]" For example: `projects/my-project/locations/global/buckets/my-bucket/links/my_link
`↳ description`	`string` Describes this link. The maximum length of the description is 8000 characters.
`↳ create_time`	`Google\Protobuf\Timestamp` Output only. The creation timestamp of the link.
`↳ lifecycle_state`	`int` Output only. The resource lifecycle state.
`↳ bigquery_dataset`	`BigQueryDataset` The information of a BigQuery Dataset. When a link is created, a BigQuery dataset is created along with it, in the same project as the LogBucket it's linked to. This dataset will also have BigQuery Views corresponding to the LogViews in the bucket.

getName

The resource name of the link. The name can have up to 100 characters.

A valid link id (at the end of the link name) must only have alphanumeric characters and underscores within it. "projects/[PROJECT_ID]/locations/[LOCATION_ID]/buckets/[BUCKET_ID]/links/[LINK_ID]" "organizations/[ORGANIZATION_ID]/locations/[LOCATION_ID]/buckets/[BUCKET_ID]/links/[LINK_ID]" "billingAccounts/[BILLING_ACCOUNT_ID]/locations/[LOCATION_ID]/buckets/[BUCKET_ID]/links/[LINK_ID]" "folders/[FOLDER_ID]/locations/[LOCATION_ID]/buckets/[BUCKET_ID]/links/[LINK_ID]" For example: `projects/my-project/locations/global/buckets/my-bucket/links/my_link

Returns
Type	Description
`string`

setName

The resource name of the link. The name can have up to 100 characters.

Parameter
Name	Description
`var`	`string`

Returns
Type	Description
`$this`

getDescription

Describes this link.

The maximum length of the description is 8000 characters.

Returns
Type	Description
`string`

setDescription

Describes this link.

The maximum length of the description is 8000 characters.

Parameter
Name	Description
`var`	`string`

Returns
Type	Description
`$this`

getCreateTime

Output only. The creation timestamp of the link.

Returns
Type	Description
`Google\Protobuf\Timestamp\|null`

hasCreateTime

clearCreateTime

setCreateTime

Output only. The creation timestamp of the link.

Parameter
Name	Description
`var`	`Google\Protobuf\Timestamp`

Returns
Type	Description
`$this`

getLifecycleState

Output only. The resource lifecycle state.

Returns
Type	Description
`int`

setLifecycleState

Output only. The resource lifecycle state.

Parameter
Name	Description
`var`	`int`

Returns
Type	Description
`$this`

getBigqueryDataset

The information of a BigQuery Dataset. When a link is created, a BigQuery dataset is created along with it, in the same project as the LogBucket it's linked to. This dataset will also have BigQuery Views corresponding to the LogViews in the bucket.

Returns
Type	Description
`BigQueryDataset\|null`

hasBigqueryDataset

clearBigqueryDataset

setBigqueryDataset

Parameter
Name	Description
`var`	`BigQueryDataset`

Returns
Type	Description
`$this`