Google API Common Protos Client - Class LogDescriptor (4.8.3)

Reference documentation and code samples for the Google API Common Protos Client class LogDescriptor.

A description of a log type. Example in YAML format:

  • name: library.googleapis.com/activity_history description: The history of borrowing and returning library items.

display_name: Activity labels:

  • key: /customer_id description: Identifier of a library customer

Generated from protobuf message google.api.LogDescriptor

Google \ Api

Methods

__construct

Constructor.

Parameters
Name Description
data array

Optional. Data for populating the Message object.

↳ name string

The name of the log. It must be less than 512 characters long and can include the following characters: upper- and lower-case alphanumeric characters [A-Za-z0-9], and punctuation characters including slash, underscore, hyphen, period [/_-.].

↳ labels array<LabelDescriptor>

The set of labels that are available to describe a specific log entry. Runtime requests that contain labels not specified here are considered invalid.

↳ description string

A human-readable description of this log. This information appears in the documentation and can contain details.

↳ display_name string

The human-readable name for this log. This information appears on the user interface and should be concise.

getName

The name of the log. It must be less than 512 characters long and can include the following characters: upper- and lower-case alphanumeric characters [A-Za-z0-9], and punctuation characters including slash, underscore, hyphen, period [/_-.].

Returns
Type Description
string

setName

The name of the log. It must be less than 512 characters long and can include the following characters: upper- and lower-case alphanumeric characters [A-Za-z0-9], and punctuation characters including slash, underscore, hyphen, period [/_-.].

Parameter
Name Description
var string
Returns
Type Description
$this

getLabels

The set of labels that are available to describe a specific log entry.

Runtime requests that contain labels not specified here are considered invalid.

Returns
Type Description
Google\Protobuf\Internal\RepeatedField

setLabels

The set of labels that are available to describe a specific log entry.

Runtime requests that contain labels not specified here are considered invalid.

Parameter
Name Description
var array<LabelDescriptor>
Returns
Type Description
$this

getDescription

A human-readable description of this log. This information appears in the documentation and can contain details.

Returns
Type Description
string

setDescription

A human-readable description of this log. This information appears in the documentation and can contain details.

Parameter
Name Description
var string
Returns
Type Description
$this

getDisplayName

The human-readable name for this log. This information appears on the user interface and should be concise.

Returns
Type Description
string

setDisplayName

The human-readable name for this log. This information appears on the user interface and should be concise.

Parameter
Name Description
var string
Returns
Type Description
$this