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 messagegoogle.api.LogDescriptor
Namespace
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 [/_-.].
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.
[[["Easy to understand","easyToUnderstand","thumb-up"],["Solved my problem","solvedMyProblem","thumb-up"],["Other","otherUp","thumb-up"]],[["Hard to understand","hardToUnderstand","thumb-down"],["Incorrect information or sample code","incorrectInformationOrSampleCode","thumb-down"],["Missing the information/samples I need","missingTheInformationSamplesINeed","thumb-down"],["Other","otherDown","thumb-down"]],["Last updated 2025-09-04 UTC."],[],[],null,["# Google API Common Protos Client - Class LogDescriptor (4.12.3)\n\nVersion latestkeyboard_arrow_down\n\n- [4.12.3 (latest)](/php/docs/reference/common-protos/latest/Api.LogDescriptor)\n- [4.12.2](/php/docs/reference/common-protos/4.12.2/Api.LogDescriptor)\n- [4.11.0](/php/docs/reference/common-protos/4.11.0/Api.LogDescriptor)\n- [4.10.0](/php/docs/reference/common-protos/4.10.0/Api.LogDescriptor)\n- [4.9.0](/php/docs/reference/common-protos/4.9.0/Api.LogDescriptor)\n- [4.8.3](/php/docs/reference/common-protos/4.8.3/Api.LogDescriptor) \nReference documentation and code samples for the Google API Common Protos Client class LogDescriptor.\n\nA description of a log type. Example in YAML format:\n\n- name: library.googleapis.com/activity_history description: The history of borrowing and returning library items.\n\ndisplay_name: Activity\nlabels:\n\n- key: /customer_id description: Identifier of a library customer\n\nGenerated from protobuf message `google.api.LogDescriptor`\n\nNamespace\n---------\n\nGoogle \\\\ Api\n\nMethods\n-------\n\n### __construct\n\nConstructor.\n\n### getName\n\nThe name of the log. It must be less than 512 characters long and can\ninclude the following characters: upper- and lower-case alphanumeric\ncharacters \\[A-Za-z0-9\\], and punctuation characters including\nslash, underscore, hyphen, period \\[/_-.\\].\n\n### setName\n\nThe name of the log. It must be less than 512 characters long and can\ninclude the following characters: upper- and lower-case alphanumeric\ncharacters \\[A-Za-z0-9\\], and punctuation characters including\nslash, underscore, hyphen, period \\[/_-.\\].\n\n### getLabels\n\nThe set of labels that are available to describe a specific log entry.\n\nRuntime requests that contain labels not specified here are\nconsidered invalid.\n\n### setLabels\n\nThe set of labels that are available to describe a specific log entry.\n\nRuntime requests that contain labels not specified here are\nconsidered invalid.\n\n### getDescription\n\nA human-readable description of this log. This information appears in\nthe documentation and can contain details.\n\n### setDescription\n\nA human-readable description of this log. This information appears in\nthe documentation and can contain details.\n\n### getDisplayName\n\nThe human-readable name for this log. This information appears on\nthe user interface and should be concise.\n\n### setDisplayName\n\nThe human-readable name for this log. This information appears on\nthe user interface and should be concise."]]
