1. class
  2. Google
  3. \
  4. Api
  5. \
  6. LogDescriptor

LogDescriptor

class LogDescriptor extends Message

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

Methods

__construct(array $data = NULL)

Constructor.

string
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 [/_-.].

$this
setName(string $var)

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 [/_-.].

RepeatedField
getLabels()

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

$this
setLabels(LabelDescriptor[]|RepeatedField $var)

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

string
getDescription()

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

$this
setDescription(string $var)

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

string
getDisplayName()

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

$this
setDisplayName(string $var)

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

Details

at line 79
__construct(array $data = NULL)

Constructor.

Parameters

array $data { Optional. Data for populating the Message object.

@type string $name
      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 [/_-.].
@type \Google\Api\LabelDescriptor[]|\Google\Protobuf\Internal\RepeatedField $labels
      The set of labels that are available to describe a specific log entry.
      Runtime requests that contain labels not specified here are
      considered invalid.
@type string $description
      A human-readable description of this log. This information appears in
      the documentation and can contain details.
@type string $display_name
      The human-readable name for this log. This information appears on
      the user interface and should be concise.

}

at line 93
string 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 [/_-.].

Generated from protobuf field string name = 1;

Return Value

string

at line 108
$this setName(string $var)

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 [/_-.].

Generated from protobuf field string name = 1;

Parameters

string $var

Return Value

$this

at line 124
RepeatedField 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.

Generated from protobuf field repeated .google.api.LabelDescriptor labels = 2;

Return Value

RepeatedField

at line 138
$this setLabels(LabelDescriptor[]|RepeatedField $var)

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

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

Generated from protobuf field repeated .google.api.LabelDescriptor labels = 2;

Parameters

LabelDescriptor[]|RepeatedField $var

Return Value

$this

at line 153
string getDescription()

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

Generated from protobuf field string description = 3;

Return Value

string

at line 166
$this setDescription(string $var)

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

Generated from protobuf field string description = 3;

Parameters

string $var

Return Value

$this

at line 181
string getDisplayName()

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

Generated from protobuf field string display_name = 4;

Return Value

string

at line 194
$this setDisplayName(string $var)

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

Generated from protobuf field string display_name = 4;

Parameters

string $var

Return Value

$this