Class LogDescriptor.Builder (2.41.0)

public static final class LogDescriptor.Builder extends GeneratedMessageV3.Builder<LogDescriptor.Builder> 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 Methods

getDescriptor()

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

Methods

addAllLabels(Iterable<? extends LabelDescriptor> values)

public LogDescriptor.Builder addAllLabels(Iterable<? extends LabelDescriptor> values)

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
values Iterable<? extends com.google.api.LabelDescriptor>
Returns
Type Description
LogDescriptor.Builder

addLabels(LabelDescriptor value)

public LogDescriptor.Builder addLabels(LabelDescriptor value)

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
value LabelDescriptor
Returns
Type Description
LogDescriptor.Builder

addLabels(LabelDescriptor.Builder builderForValue)

public LogDescriptor.Builder addLabels(LabelDescriptor.Builder builderForValue)

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
builderForValue LabelDescriptor.Builder
Returns
Type Description
LogDescriptor.Builder

addLabels(int index, LabelDescriptor value)

public LogDescriptor.Builder addLabels(int index, LabelDescriptor value)

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;

Parameters
Name Description
index int
value LabelDescriptor
Returns
Type Description
LogDescriptor.Builder

addLabels(int index, LabelDescriptor.Builder builderForValue)

public LogDescriptor.Builder addLabels(int index, LabelDescriptor.Builder builderForValue)

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;

Parameters
Name Description
index int
builderForValue LabelDescriptor.Builder
Returns
Type Description
LogDescriptor.Builder

addLabelsBuilder()

public LabelDescriptor.Builder addLabelsBuilder()

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
LabelDescriptor.Builder

addLabelsBuilder(int index)

public LabelDescriptor.Builder addLabelsBuilder(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.Builder

addRepeatedField(Descriptors.FieldDescriptor field, Object value)

public LogDescriptor.Builder addRepeatedField(Descriptors.FieldDescriptor field, Object value)
Parameters
Name Description
field FieldDescriptor
value Object
Returns
Type Description
LogDescriptor.Builder
Overrides

build()

public LogDescriptor build()
Returns
Type Description
LogDescriptor

buildPartial()

public LogDescriptor buildPartial()
Returns
Type Description
LogDescriptor

clear()

public LogDescriptor.Builder clear()
Returns
Type Description
LogDescriptor.Builder
Overrides

clearDescription()

public LogDescriptor.Builder clearDescription()

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

string description = 3;

Returns
Type Description
LogDescriptor.Builder

This builder for chaining.

clearDisplayName()

public LogDescriptor.Builder clearDisplayName()

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
LogDescriptor.Builder

This builder for chaining.

clearField(Descriptors.FieldDescriptor field)

public LogDescriptor.Builder clearField(Descriptors.FieldDescriptor field)
Parameter
Name Description
field FieldDescriptor
Returns
Type Description
LogDescriptor.Builder
Overrides

clearLabels()

public LogDescriptor.Builder clearLabels()

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
LogDescriptor.Builder

clearName()

public LogDescriptor.Builder clearName()

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
LogDescriptor.Builder

This builder for chaining.

clearOneof(Descriptors.OneofDescriptor oneof)

public LogDescriptor.Builder clearOneof(Descriptors.OneofDescriptor oneof)
Parameter
Name Description
oneof OneofDescriptor
Returns
Type Description
LogDescriptor.Builder
Overrides

clone()

public LogDescriptor.Builder clone()
Returns
Type Description
LogDescriptor.Builder
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.

getDescriptorForType()

public Descriptors.Descriptor getDescriptorForType()
Returns
Type Description
Descriptor
Overrides

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

getLabelsBuilder(int index)

public LabelDescriptor.Builder getLabelsBuilder(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.Builder

getLabelsBuilderList()

public List<LabelDescriptor.Builder> getLabelsBuilderList()

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<Builder>

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.

internalGetFieldAccessorTable()

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

isInitialized()

public final boolean isInitialized()
Returns
Type Description
boolean
Overrides

mergeFrom(LogDescriptor other)

public LogDescriptor.Builder mergeFrom(LogDescriptor other)
Parameter
Name Description
other LogDescriptor
Returns
Type Description
LogDescriptor.Builder

mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public LogDescriptor.Builder mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input CodedInputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
LogDescriptor.Builder
Overrides
Exceptions
Type Description
IOException

mergeFrom(Message other)

public LogDescriptor.Builder mergeFrom(Message other)
Parameter
Name Description
other Message
Returns
Type Description
LogDescriptor.Builder
Overrides

mergeUnknownFields(UnknownFieldSet unknownFields)

public final LogDescriptor.Builder mergeUnknownFields(UnknownFieldSet unknownFields)
Parameter
Name Description
unknownFields UnknownFieldSet
Returns
Type Description
LogDescriptor.Builder
Overrides

removeLabels(int index)

public LogDescriptor.Builder removeLabels(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
LogDescriptor.Builder

setDescription(String value)

public LogDescriptor.Builder setDescription(String value)

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

string description = 3;

Parameter
Name Description
value String

The description to set.

Returns
Type Description
LogDescriptor.Builder

This builder for chaining.

setDescriptionBytes(ByteString value)

public LogDescriptor.Builder setDescriptionBytes(ByteString value)

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

string description = 3;

Parameter
Name Description
value ByteString

The bytes for description to set.

Returns
Type Description
LogDescriptor.Builder

This builder for chaining.

setDisplayName(String value)

public LogDescriptor.Builder setDisplayName(String value)

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

string display_name = 4;

Parameter
Name Description
value String

The displayName to set.

Returns
Type Description
LogDescriptor.Builder

This builder for chaining.

setDisplayNameBytes(ByteString value)

public LogDescriptor.Builder setDisplayNameBytes(ByteString value)

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

string display_name = 4;

Parameter
Name Description
value ByteString

The bytes for displayName to set.

Returns
Type Description
LogDescriptor.Builder

This builder for chaining.

setField(Descriptors.FieldDescriptor field, Object value)

public LogDescriptor.Builder setField(Descriptors.FieldDescriptor field, Object value)
Parameters
Name Description
field FieldDescriptor
value Object
Returns
Type Description
LogDescriptor.Builder
Overrides

setLabels(int index, LabelDescriptor value)

public LogDescriptor.Builder setLabels(int index, LabelDescriptor value)

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;

Parameters
Name Description
index int
value LabelDescriptor
Returns
Type Description
LogDescriptor.Builder

setLabels(int index, LabelDescriptor.Builder builderForValue)

public LogDescriptor.Builder setLabels(int index, LabelDescriptor.Builder builderForValue)

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;

Parameters
Name Description
index int
builderForValue LabelDescriptor.Builder
Returns
Type Description
LogDescriptor.Builder

setName(String value)

public LogDescriptor.Builder setName(String value)

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;

Parameter
Name Description
value String

The name to set.

Returns
Type Description
LogDescriptor.Builder

This builder for chaining.

setNameBytes(ByteString value)

public LogDescriptor.Builder setNameBytes(ByteString value)

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;

Parameter
Name Description
value ByteString

The bytes for name to set.

Returns
Type Description
LogDescriptor.Builder

This builder for chaining.

setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)

public LogDescriptor.Builder setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)
Parameters
Name Description
field FieldDescriptor
index int
value Object
Returns
Type Description
LogDescriptor.Builder
Overrides

setUnknownFields(UnknownFieldSet unknownFields)

public final LogDescriptor.Builder setUnknownFields(UnknownFieldSet unknownFields)
Parameter
Name Description
unknownFields UnknownFieldSet
Returns
Type Description
LogDescriptor.Builder
Overrides