Google Cloud Chronicle V1 Client - Class FeedSourceTypeSchema (0.7.1)

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

Metadata that pertains to feed source types (see Feed.FeedDetails.FeedSourceType) that is useful for building interfaces to construct valid Feed messages.

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

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 for this FeedSourceTypeSchema. Format: "projects/{project}/locations/{location}/instances/{instance}/feedSourceTypeSchemas/{feed_source_type}".

↳ display_name string

A human-readable name for this feed source type.

↳ description string

A human-readable description for this feed source type.

↳ read_only bool

Whether feeds having this source type, while they are expected to exist, should not be modified (created, edited, or deleted).

↳ feed_source_type int

The value to be used in the details.feed_source_type field in the Feed message.

getName

The resource name for this FeedSourceTypeSchema.

Format: "projects/{project}/locations/{location}/instances/{instance}/feedSourceTypeSchemas/{feed_source_type}".

Returns
Type Description
string

setName

The resource name for this FeedSourceTypeSchema.

Format: "projects/{project}/locations/{location}/instances/{instance}/feedSourceTypeSchemas/{feed_source_type}".

Parameter
Name Description
var string
Returns
Type Description
$this

getDisplayName

A human-readable name for this feed source type.

Returns
Type Description
string

setDisplayName

A human-readable name for this feed source type.

Parameter
Name Description
var string
Returns
Type Description
$this

getDescription

A human-readable description for this feed source type.

Returns
Type Description
string

setDescription

A human-readable description for this feed source type.

Parameter
Name Description
var string
Returns
Type Description
$this

getReadOnly

Whether feeds having this source type, while they are expected to exist, should not be modified (created, edited, or deleted).

Returns
Type Description
bool

setReadOnly

Whether feeds having this source type, while they are expected to exist, should not be modified (created, edited, or deleted).

Parameter
Name Description
var bool
Returns
Type Description
$this

getFeedSourceType

The value to be used in the details.feed_source_type field in the Feed message.

Returns
Type Description
int Enum of type FeedSourceType.

setFeedSourceType

The value to be used in the details.feed_source_type field in the Feed message.

Parameter
Name Description
var int

Enum of type FeedSourceType.

Returns
Type Description
$this