Class LogDescriptor (2.10.0)

public sealed class LogDescriptor : IMessage<LogDescriptor>, IEquatable<LogDescriptor>, IDeepCloneable<LogDescriptor>, IBufferMessage, IMessage

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

Inheritance

object > LogDescriptor

Namespace

Google.Api

Assembly

Google.Api.CommonProtos.dll

Constructors

LogDescriptor()

public LogDescriptor()

LogDescriptor(LogDescriptor)

public LogDescriptor(LogDescriptor other)
Parameter
Name Description
other LogDescriptor

Fields

DescriptionFieldNumber

public const int DescriptionFieldNumber = 3

Field number for the "description" field.

Field Value
Type Description
int

DisplayNameFieldNumber

public const int DisplayNameFieldNumber = 4

Field number for the "display_name" field.

Field Value
Type Description
int

LabelsFieldNumber

public const int LabelsFieldNumber = 2

Field number for the "labels" field.

Field Value
Type Description
int

NameFieldNumber

public const int NameFieldNumber = 1

Field number for the "name" field.

Field Value
Type Description
int

Properties

Description

public string Description { get; set; }

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

Property Value
Type Description
string

Descriptor

public static MessageDescriptor Descriptor { get; }
Property Value
Type Description
MessageDescriptor

DisplayName

public string DisplayName { get; set; }

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

Property Value
Type Description
string

Labels

public RepeatedField<LabelDescriptor> Labels { get; }

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

Property Value
Type Description
RepeatedFieldLabelDescriptor

Name

public string Name { get; set; }

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

Property Value
Type Description
string

Parser

public static MessageParser<LogDescriptor> Parser { get; }
Property Value
Type Description
MessageParserLogDescriptor

Methods

CalculateSize()

public int CalculateSize()
Returns
Type Description
int

Clone()

public LogDescriptor Clone()
Returns
Type Description
LogDescriptor

Equals(LogDescriptor)

public bool Equals(LogDescriptor other)
Parameter
Name Description
other LogDescriptor
Returns
Type Description
bool

Equals(object)

public override bool Equals(object other)
Parameter
Name Description
other object
Returns
Type Description
bool
Overrides

GetHashCode()

public override int GetHashCode()
Returns
Type Description
int
Overrides

MergeFrom(LogDescriptor)

public void MergeFrom(LogDescriptor other)
Parameter
Name Description
other LogDescriptor

MergeFrom(CodedInputStream)

public void MergeFrom(CodedInputStream input)
Parameter
Name Description
input CodedInputStream

ToString()

public override string ToString()
Returns
Type Description
string
Overrides

WriteTo(CodedOutputStream)

public void WriteTo(CodedOutputStream output)
Parameter
Name Description
output CodedOutputStream