Class LogDescriptor (2.9.1)

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

Static Fields

DESCRIPTION_FIELD_NUMBER

public static final int DESCRIPTION_FIELD_NUMBER
Field Value
TypeDescription
int

DISPLAY_NAME_FIELD_NUMBER

public static final int DISPLAY_NAME_FIELD_NUMBER
Field Value
TypeDescription
int

LABELS_FIELD_NUMBER

public static final int LABELS_FIELD_NUMBER
Field Value
TypeDescription
int

NAME_FIELD_NUMBER

public static final int NAME_FIELD_NUMBER
Field Value
TypeDescription
int

Static Methods

getDefaultInstance()

public static LogDescriptor getDefaultInstance()
Returns
TypeDescription
LogDescriptor

getDescriptor()

public static final Descriptors.Descriptor getDescriptor()
Returns
TypeDescription
Descriptor

newBuilder()

public static LogDescriptor.Builder newBuilder()
Returns
TypeDescription
LogDescriptor.Builder

newBuilder(LogDescriptor prototype)

public static LogDescriptor.Builder newBuilder(LogDescriptor prototype)
Parameter
NameDescription
prototypeLogDescriptor
Returns
TypeDescription
LogDescriptor.Builder

parseDelimitedFrom(InputStream input)

public static LogDescriptor parseDelimitedFrom(InputStream input)
Parameter
NameDescription
inputInputStream
Returns
TypeDescription
LogDescriptor
Exceptions
TypeDescription
IOException

parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static LogDescriptor parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
inputInputStream
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
LogDescriptor
Exceptions
TypeDescription
IOException

parseFrom(byte[] data)

public static LogDescriptor parseFrom(byte[] data)
Parameter
NameDescription
databyte[]
Returns
TypeDescription
LogDescriptor
Exceptions
TypeDescription
InvalidProtocolBufferException

parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)

public static LogDescriptor parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
databyte[]
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
LogDescriptor
Exceptions
TypeDescription
InvalidProtocolBufferException

parseFrom(ByteString data)

public static LogDescriptor parseFrom(ByteString data)
Parameter
NameDescription
dataByteString
Returns
TypeDescription
LogDescriptor
Exceptions
TypeDescription
InvalidProtocolBufferException

parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)

public static LogDescriptor parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
dataByteString
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
LogDescriptor
Exceptions
TypeDescription
InvalidProtocolBufferException

parseFrom(CodedInputStream input)

public static LogDescriptor parseFrom(CodedInputStream input)
Parameter
NameDescription
inputCodedInputStream
Returns
TypeDescription
LogDescriptor
Exceptions
TypeDescription
IOException

parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public static LogDescriptor parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
inputCodedInputStream
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
LogDescriptor
Exceptions
TypeDescription
IOException

parseFrom(InputStream input)

public static LogDescriptor parseFrom(InputStream input)
Parameter
NameDescription
inputInputStream
Returns
TypeDescription
LogDescriptor
Exceptions
TypeDescription
IOException

parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static LogDescriptor parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
inputInputStream
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
LogDescriptor
Exceptions
TypeDescription
IOException

parseFrom(ByteBuffer data)

public static LogDescriptor parseFrom(ByteBuffer data)
Parameter
NameDescription
dataByteBuffer
Returns
TypeDescription
LogDescriptor
Exceptions
TypeDescription
InvalidProtocolBufferException

parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)

public static LogDescriptor parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
dataByteBuffer
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
LogDescriptor
Exceptions
TypeDescription
InvalidProtocolBufferException

parser()

public static Parser<LogDescriptor> parser()
Returns
TypeDescription
Parser<LogDescriptor>

Methods

equals(Object obj)

public boolean equals(Object obj)
Parameter
NameDescription
objObject
Returns
TypeDescription
boolean
Overrides

getDefaultInstanceForType()

public LogDescriptor getDefaultInstanceForType()
Returns
TypeDescription
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
TypeDescription
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
TypeDescription
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
TypeDescription
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
TypeDescription
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
NameDescription
indexint
Returns
TypeDescription
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
TypeDescription
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
TypeDescription
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
NameDescription
indexint
Returns
TypeDescription
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
TypeDescription
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
TypeDescription
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
TypeDescription
ByteString

The bytes for name.

getParserForType()

public Parser<LogDescriptor> getParserForType()
Returns
TypeDescription
Parser<LogDescriptor>
Overrides

getSerializedSize()

public int getSerializedSize()
Returns
TypeDescription
int
Overrides

getUnknownFields()

public final UnknownFieldSet getUnknownFields()
Returns
TypeDescription
UnknownFieldSet
Overrides

hashCode()

public int hashCode()
Returns
TypeDescription
int
Overrides

internalGetFieldAccessorTable()

protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Returns
TypeDescription
FieldAccessorTable
Overrides

isInitialized()

public final boolean isInitialized()
Returns
TypeDescription
boolean
Overrides

newBuilderForType()

public LogDescriptor.Builder newBuilderForType()
Returns
TypeDescription
LogDescriptor.Builder

newBuilderForType(GeneratedMessageV3.BuilderParent parent)

protected LogDescriptor.Builder newBuilderForType(GeneratedMessageV3.BuilderParent parent)
Parameter
NameDescription
parentBuilderParent
Returns
TypeDescription
LogDescriptor.Builder
Overrides

newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)

protected Object newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
Parameter
NameDescription
unusedUnusedPrivateParameter
Returns
TypeDescription
Object
Overrides

toBuilder()

public LogDescriptor.Builder toBuilder()
Returns
TypeDescription
LogDescriptor.Builder

writeTo(CodedOutputStream output)

public void writeTo(CodedOutputStream output)
Parameter
NameDescription
outputCodedOutputStream
Overrides Exceptions
TypeDescription
IOException