Class LogDescriptor (2.40.0) 

public final class LogDescriptor extends GeneratedMessageV3 implements LogDescriptorOrBuilder

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

Protobuf type google.api.LogDescriptor

Inheritance

Object > AbstractMessageLite<MessageType,BuilderType> > AbstractMessage > GeneratedMessageV3 > LogDescriptor

Static Fields

DESCRIPTION_FIELD_NUMBER

public static final int DESCRIPTION_FIELD_NUMBER
Field Value
Type Description
int

DISPLAY_NAME_FIELD_NUMBER

public static final int DISPLAY_NAME_FIELD_NUMBER
Field Value
Type Description
int

LABELS_FIELD_NUMBER

public static final int LABELS_FIELD_NUMBER
Field Value
Type Description
int

NAME_FIELD_NUMBER

public static final int NAME_FIELD_NUMBER
Field Value
Type Description
int

Static Methods

getDefaultInstance()

public static LogDescriptor getDefaultInstance()
Returns
Type Description
LogDescriptor

getDescriptor()

public static final Descriptors.Descriptor getDescriptor()
Returns
Type Description
Descriptor

newBuilder()

public static LogDescriptor.Builder newBuilder()
Returns
Type Description
LogDescriptor.Builder

newBuilder(LogDescriptor prototype)

public static LogDescriptor.Builder newBuilder(LogDescriptor prototype)
Parameter
Name Description
prototype LogDescriptor
Returns
Type Description
LogDescriptor.Builder

parseDelimitedFrom(InputStream input)

public static LogDescriptor parseDelimitedFrom(InputStream input)
Parameter
Name Description
input InputStream
Returns
Type Description
LogDescriptor
Exceptions
Type Description
IOException

parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static LogDescriptor parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input InputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
LogDescriptor
Exceptions
Type Description
IOException

parseFrom(byte[] data)

public static LogDescriptor parseFrom(byte[] data)
Parameter
Name Description
data byte[]
Returns
Type Description
LogDescriptor
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)

public static LogDescriptor parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
data byte[]
extensionRegistry ExtensionRegistryLite
Returns
Type Description
LogDescriptor
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteString data)

public static LogDescriptor parseFrom(ByteString data)
Parameter
Name Description
data ByteString
Returns
Type Description
LogDescriptor
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)

public static LogDescriptor parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
data ByteString
extensionRegistry ExtensionRegistryLite
Returns
Type Description
LogDescriptor
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(CodedInputStream input)

public static LogDescriptor parseFrom(CodedInputStream input)
Parameter
Name Description
input CodedInputStream
Returns
Type Description
LogDescriptor
Exceptions
Type Description
IOException

parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public static LogDescriptor parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input CodedInputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
LogDescriptor
Exceptions
Type Description
IOException

parseFrom(InputStream input)

public static LogDescriptor parseFrom(InputStream input)
Parameter
Name Description
input InputStream
Returns
Type Description
LogDescriptor
Exceptions
Type Description
IOException

parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static LogDescriptor parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input InputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
LogDescriptor
Exceptions
Type Description
IOException

parseFrom(ByteBuffer data)

public static LogDescriptor parseFrom(ByteBuffer data)
Parameter
Name Description
data ByteBuffer
Returns
Type Description
LogDescriptor
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)

public static LogDescriptor parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
data ByteBuffer
extensionRegistry ExtensionRegistryLite
Returns
Type Description
LogDescriptor
Exceptions
Type Description
InvalidProtocolBufferException

parser()

public static Parser<LogDescriptor> parser()
Returns
Type Description
Parser<LogDescriptor>

Methods

equals(Object obj)

public boolean equals(Object obj)
Parameter
Name Description
obj Object
Returns
Type Description
boolean
Overrides

getDefaultInstanceForType()

public LogDescriptor getDefaultInstanceForType()
Returns
Type Description
LogDescriptor

getDescription()

public String getDescription()

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

string description = 3;

Returns
Type Description
String

The description.

getDescriptionBytes()

public ByteString getDescriptionBytes()

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

string description = 3;

Returns
Type Description
ByteString

The bytes for description.

getDisplayName()

public String getDisplayName()

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

string display_name = 4;

Returns
Type Description
String

The displayName.

getDisplayNameBytes()

public ByteString getDisplayNameBytes()

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

string display_name = 4;

Returns
Type Description
ByteString

The bytes for displayName.

getLabels(int index)

public LabelDescriptor getLabels(int index)

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

repeated .google.api.LabelDescriptor labels = 2;

Parameter
Name Description
index int
Returns
Type Description
LabelDescriptor

getLabelsCount()

public int getLabelsCount()

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

repeated .google.api.LabelDescriptor labels = 2;

Returns
Type Description
int

getLabelsList()

public List<LabelDescriptor> getLabelsList()

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

repeated .google.api.LabelDescriptor labels = 2;

Returns
Type Description
List<LabelDescriptor>

getLabelsOrBuilder(int index)

public LabelDescriptorOrBuilder getLabelsOrBuilder(int index)

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

repeated .google.api.LabelDescriptor labels = 2;

Parameter
Name Description
index int
Returns
Type Description
LabelDescriptorOrBuilder

getLabelsOrBuilderList()

public List<? extends LabelDescriptorOrBuilder> getLabelsOrBuilderList()

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

repeated .google.api.LabelDescriptor labels = 2;

Returns
Type Description
List<? extends com.google.api.LabelDescriptorOrBuilder>

getName()

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

string name = 1;

Returns
Type Description
String

The name.

getNameBytes()

public ByteString getNameBytes()

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

string name = 1;

Returns
Type Description
ByteString

The bytes for name.

getParserForType()

public Parser<LogDescriptor> getParserForType()
Returns
Type Description
Parser<LogDescriptor>
Overrides

getSerializedSize()

public int getSerializedSize()
Returns
Type Description
int
Overrides

hashCode()

public int hashCode()
Returns
Type Description
int
Overrides

internalGetFieldAccessorTable()

protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Returns
Type Description
FieldAccessorTable
Overrides

isInitialized()

public final boolean isInitialized()
Returns
Type Description
boolean
Overrides

newBuilderForType()

public LogDescriptor.Builder newBuilderForType()
Returns
Type Description
LogDescriptor.Builder

newBuilderForType(GeneratedMessageV3.BuilderParent parent)

protected LogDescriptor.Builder newBuilderForType(GeneratedMessageV3.BuilderParent parent)
Parameter
Name Description
parent BuilderParent
Returns
Type Description
LogDescriptor.Builder
Overrides

newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)

protected Object newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
Parameter
Name Description
unused UnusedPrivateParameter
Returns
Type Description
Object
Overrides

toBuilder()

public LogDescriptor.Builder toBuilder()
Returns
Type Description
LogDescriptor.Builder

writeTo(CodedOutputStream output)

public void writeTo(CodedOutputStream output)
Parameter
Name Description
output CodedOutputStream
Overrides
Exceptions
Type Description
IOException