Google Cloud Chronicle V1 Client - Class Feed (0.7.1)

Reference documentation and code samples for the Google Cloud Chronicle V1 Client class Feed.

Feed is a resource that contains feed information needed to create a feed.

Generated from protobuf message google.cloud.chronicle.v1.Feed

Namespace

Google \ Cloud \ Chronicle \ V1

Methods

__construct

Constructor.

Parameters
Name	Description
`data`	`array` Optional. Data for populating the Message object.
`↳ name`	`string` The resource name of the feed. Format: projects/{project}/locations/{location}/instances/{instance}/feeds/{feed}
`↳ uid`	`string` Output only. Unique identifier for the feed.
`↳ display_name`	`string` Customer-provided feed name.
`↳ details`	`FeedDetails` Additional details of the feed, these details are dynamic and will be different for each of the feeds.
`↳ state`	`int` Output only. State of the feed.
`↳ failure_msg`	`string` Output only. Details about the most recent failure when feed state is FAILED.
`↳ read_only`	`bool` Output only. Whether this feed can be updated or deleted.
`↳ last_feed_initiation_time`	`Google\Protobuf\Timestamp` Output only. Latest timestamp when the transfer was successful for the feed.
`↳ failure_details`	`FeedFailureDetails` Output only. Failure details for the feed. If the feed is in the failure state, this field will contain the details of the error cause and actions.
`↳ reference_id`	`string` Output only. Reference ID, this field will contain the legacy id of the feed.

getName

The resource name of the feed.

Format: projects/{project}/locations/{location}/instances/{instance}/feeds/{feed}

Returns
Type	Description
`string`

setName

The resource name of the feed.

Format: projects/{project}/locations/{location}/instances/{instance}/feeds/{feed}

Parameter
Name	Description
`var`	`string`

Returns
Type	Description
`$this`

getUid

Output only. Unique identifier for the feed.

Returns
Type	Description
`string`

setUid

Output only. Unique identifier for the feed.

Parameter
Name	Description
`var`	`string`

Returns
Type	Description
`$this`

getDisplayName

Customer-provided feed name.

Returns
Type	Description
`string`

setDisplayName

Customer-provided feed name.

Parameter
Name	Description
`var`	`string`

Returns
Type	Description
`$this`

getDetails

Additional details of the feed, these details are dynamic and will be different for each of the feeds.

Returns
Type	Description
`FeedDetails\|null`

hasDetails

clearDetails

setDetails

Additional details of the feed, these details are dynamic and will be different for each of the feeds.

Parameter
Name	Description
`var`	`FeedDetails`

Returns
Type	Description
`$this`

getState

Output only. State of the feed.

Returns
Type	Description
`int`	Enum of type State.

setState

Output only. State of the feed.

Parameter
Name	Description
`var`	`int` Enum of type State.

Returns
Type	Description
`$this`

getFailureMsg

Output only. Details about the most recent failure when feed state is FAILED.

Returns
Type	Description
`string`

setFailureMsg

Output only. Details about the most recent failure when feed state is FAILED.

Parameter
Name	Description
`var`	`string`

Returns
Type	Description
`$this`

getReadOnly

Output only. Whether this feed can be updated or deleted.

Returns
Type	Description
`bool`

setReadOnly