LogMetric.Builder (proto-google-cloud-logging-v2 0.1.12 API)

java.lang.Object
- com.google.protobuf.AbstractMessageLite.Builder
- - com.google.protobuf.AbstractMessage.Builder<BuilderType>
  - - com.google.protobuf.GeneratedMessageV3.Builder<LogMetric.Builder>
    - - com.google.logging.v2.LogMetric.Builder

All Implemented Interfaces:: LogMetricOrBuilder, com.google.protobuf.Message.Builder, com.google.protobuf.MessageLite.Builder, com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder, java.lang.Cloneable

Enclosing class:: LogMetric

public static final class LogMetric.Builder
extends com.google.protobuf.GeneratedMessageV3.Builder<LogMetric.Builder>
implements LogMetricOrBuilder

 Describes a logs-based metric.  The value of the metric is the
 number of log entries that match a logs filter in a given time interval.

Protobuf type google.logging.v2.LogMetric

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`LogMetric.Builder`	`addRepeatedField(com.google.protobuf.Descriptors.FieldDescriptor field, java.lang.Object value)`
`LogMetric`	`build()`
`LogMetric`	`buildPartial()`
`LogMetric.Builder`	`clear()`
`LogMetric.Builder`	`clearDescription()` Optional.
`LogMetric.Builder`	`clearField(com.google.protobuf.Descriptors.FieldDescriptor field)`
`LogMetric.Builder`	`clearFilter()` Required.
`LogMetric.Builder`	`clearName()` Required.
`LogMetric.Builder`	`clearOneof(com.google.protobuf.Descriptors.OneofDescriptor oneof)`
`LogMetric.Builder`	`clearVersion()` Output only.
`LogMetric.Builder`	`clone()`
`LogMetric`	`getDefaultInstanceForType()`
`java.lang.String`	`getDescription()` Optional.
`com.google.protobuf.ByteString`	`getDescriptionBytes()` Optional.
`static com.google.protobuf.Descriptors.Descriptor`	`getDescriptor()`
`com.google.protobuf.Descriptors.Descriptor`	`getDescriptorForType()`
`java.lang.String`	`getFilter()` Required.
`com.google.protobuf.ByteString`	`getFilterBytes()` Required.
`java.lang.String`	`getName()` Required.
`com.google.protobuf.ByteString`	`getNameBytes()` Required.
`LogMetric.ApiVersion`	`getVersion()` Output only.
`int`	`getVersionValue()` Output only.
`protected com.google.protobuf.GeneratedMessageV3.FieldAccessorTable`	`internalGetFieldAccessorTable()`
`boolean`	`isInitialized()`
`LogMetric.Builder`	`mergeFrom(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)`
`LogMetric.Builder`	`mergeFrom(LogMetric other)`
`LogMetric.Builder`	`mergeFrom(com.google.protobuf.Message other)`
`LogMetric.Builder`	`mergeUnknownFields(com.google.protobuf.UnknownFieldSet unknownFields)`
`LogMetric.Builder`	`setDescription(java.lang.String value)` Optional.
`LogMetric.Builder`	`setDescriptionBytes(com.google.protobuf.ByteString value)` Optional.
`LogMetric.Builder`	`setField(com.google.protobuf.Descriptors.FieldDescriptor field, java.lang.Object value)`
`LogMetric.Builder`	`setFilter(java.lang.String value)` Required.
`LogMetric.Builder`	`setFilterBytes(com.google.protobuf.ByteString value)` Required.
`LogMetric.Builder`	`setName(java.lang.String value)` Required.
`LogMetric.Builder`	`setNameBytes(com.google.protobuf.ByteString value)` Required.
`LogMetric.Builder`	`setRepeatedField(com.google.protobuf.Descriptors.FieldDescriptor field, int index, java.lang.Object value)`
`LogMetric.Builder`	`setUnknownFields(com.google.protobuf.UnknownFieldSet unknownFields)`
`LogMetric.Builder`	`setVersion(LogMetric.ApiVersion value)` Output only.
`LogMetric.Builder`	`setVersionValue(int value)` Output only.

Methods inherited from class com.google.protobuf.GeneratedMessageV3.Builder
getAllFields, getField, getFieldBuilder, getOneofFieldDescriptor, getParentForChildren, getRepeatedField, getRepeatedFieldBuilder, getRepeatedFieldCount, getUnknownFields, hasField, hasOneof, internalGetMapField, internalGetMutableMapField, isClean, markClean, newBuilderForField, onBuilt, onChanged, parseUnknownField

Methods inherited from class com.google.protobuf.AbstractMessage.Builder
findInitializationErrors, getInitializationErrorString, internalMergeFrom, mergeDelimitedFrom, mergeDelimitedFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, newUninitializedMessageException, toString

Methods inherited from class com.google.protobuf.AbstractMessageLite.Builder
addAll, mergeFrom, newUninitializedMessageException

Methods inherited from class java.lang.Object
equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Methods inherited from interface com.google.protobuf.MessageOrBuilder
findInitializationErrors, getAllFields, getField, getInitializationErrorString, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, getUnknownFields, hasField, hasOneof

Methods inherited from interface com.google.protobuf.MessageLite.Builder
mergeFrom

Method Detail

getDescriptor

public static final com.google.protobuf.Descriptors.Descriptor getDescriptor()

internalGetFieldAccessorTable
```
protected com.google.protobuf.GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
```
Specified by:

internalGetFieldAccessorTable in class com.google.protobuf.GeneratedMessageV3.Builder<LogMetric.Builder>

clear
```
public LogMetric.Builder clear()
```
Specified by:

clear in interface com.google.protobuf.Message.Builder

Specified by:

clear in interface com.google.protobuf.MessageLite.Builder

Overrides:

clear in class com.google.protobuf.GeneratedMessageV3.Builder<LogMetric.Builder>

getDescriptorForType
```
public com.google.protobuf.Descriptors.Descriptor getDescriptorForType()
```
Specified by:

getDescriptorForType in interface com.google.protobuf.Message.Builder

Specified by:

getDescriptorForType in interface com.google.protobuf.MessageOrBuilder

Overrides:

getDescriptorForType in class com.google.protobuf.GeneratedMessageV3.Builder<LogMetric.Builder>

getDefaultInstanceForType
```
public LogMetric getDefaultInstanceForType()
```
Specified by:

getDefaultInstanceForType in interface com.google.protobuf.MessageLiteOrBuilder

Specified by:

getDefaultInstanceForType in interface com.google.protobuf.MessageOrBuilder

build
```
public LogMetric build()
```
Specified by:

build in interface com.google.protobuf.Message.Builder

Specified by:

build in interface com.google.protobuf.MessageLite.Builder

buildPartial
```
public LogMetric buildPartial()
```
Specified by:

buildPartial in interface com.google.protobuf.Message.Builder

Specified by:

buildPartial in interface com.google.protobuf.MessageLite.Builder

clone
```
public LogMetric.Builder clone()
```
Specified by:

clone in interface com.google.protobuf.Message.Builder

Specified by:

clone in interface com.google.protobuf.MessageLite.Builder

Overrides:

clone in class com.google.protobuf.GeneratedMessageV3.Builder<LogMetric.Builder>

setField
```
public LogMetric.Builder setField(com.google.protobuf.Descriptors.FieldDescriptor field,
                                  java.lang.Object value)
```
Specified by:

setField in interface com.google.protobuf.Message.Builder

Overrides:

setField in class com.google.protobuf.GeneratedMessageV3.Builder<LogMetric.Builder>

clearField
```
public LogMetric.Builder clearField(com.google.protobuf.Descriptors.FieldDescriptor field)
```
Specified by:

clearField in interface com.google.protobuf.Message.Builder

Overrides:

clearField in class com.google.protobuf.GeneratedMessageV3.Builder<LogMetric.Builder>

clearOneof
```
public LogMetric.Builder clearOneof(com.google.protobuf.Descriptors.OneofDescriptor oneof)
```
Specified by:

clearOneof in interface com.google.protobuf.Message.Builder

Overrides:

clearOneof in class com.google.protobuf.GeneratedMessageV3.Builder<LogMetric.Builder>

setRepeatedField

public LogMetric.Builder setRepeatedField(com.google.protobuf.Descriptors.FieldDescriptor field,
                                          int index,
                                          java.lang.Object value)

Specified by:: setRepeatedField in interface com.google.protobuf.Message.Builder
Overrides:: setRepeatedField in class com.google.protobuf.GeneratedMessageV3.Builder<LogMetric.Builder>

addRepeatedField
```
public LogMetric.Builder addRepeatedField(com.google.protobuf.Descriptors.FieldDescriptor field,
                                          java.lang.Object value)
```
Specified by:

addRepeatedField in interface com.google.protobuf.Message.Builder

Overrides:

addRepeatedField in class com.google.protobuf.GeneratedMessageV3.Builder<LogMetric.Builder>

mergeFrom
```
public LogMetric.Builder mergeFrom(com.google.protobuf.Message other)
```
Specified by:

mergeFrom in interface com.google.protobuf.Message.Builder

Overrides:

mergeFrom in class com.google.protobuf.AbstractMessage.Builder<LogMetric.Builder>

mergeFrom

public LogMetric.Builder mergeFrom(LogMetric other)

isInitialized
```
public final boolean isInitialized()
```
Specified by:

isInitialized in interface com.google.protobuf.MessageLiteOrBuilder

Overrides:

isInitialized in class com.google.protobuf.GeneratedMessageV3.Builder<LogMetric.Builder>

mergeFrom
```
public LogMetric.Builder mergeFrom(com.google.protobuf.CodedInputStream input,
                                   com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                            throws java.io.IOException
```
Specified by:

mergeFrom in interface com.google.protobuf.Message.Builder

Specified by:

mergeFrom in interface com.google.protobuf.MessageLite.Builder

Overrides:

mergeFrom in class com.google.protobuf.AbstractMessage.Builder<LogMetric.Builder>

Throws:

java.io.IOException

getName

public java.lang.String getName()

 Required. The client-assigned metric identifier.
 Examples: `"error_count"`, `"nginx/requests"`.
 Metric identifiers are limited to 100 characters and can include
 only the following characters: `A-Z`, `a-z`, `0-9`, and the
 special characters `_-.,+!*',()%/`.  The forward-slash character
 (`/`) denotes a hierarchy of name pieces, and it cannot be the
 first character of the name.
 The metric identifier in this field must not be
 [URL-encoded](https://en.wikipedia.org/wiki/Percent-encoding).
 However, when the metric identifier appears as the `[METRIC_ID]`
 part of a `metric_name` API parameter, then the metric identifier
 must be URL-encoded. Example:
 `"projects/my-project/metrics/nginx%2Frequests"`.

string name = 1;

Specified by:: getName in interface LogMetricOrBuilder

getNameBytes

public com.google.protobuf.ByteString getNameBytes()

 Required. The client-assigned metric identifier.
 Examples: `"error_count"`, `"nginx/requests"`.
 Metric identifiers are limited to 100 characters and can include
 only the following characters: `A-Z`, `a-z`, `0-9`, and the
 special characters `_-.,+!*',()%/`.  The forward-slash character
 (`/`) denotes a hierarchy of name pieces, and it cannot be the
 first character of the name.
 The metric identifier in this field must not be
 [URL-encoded](https://en.wikipedia.org/wiki/Percent-encoding).
 However, when the metric identifier appears as the `[METRIC_ID]`
 part of a `metric_name` API parameter, then the metric identifier
 must be URL-encoded. Example:
 `"projects/my-project/metrics/nginx%2Frequests"`.

string name = 1;

Specified by:: getNameBytes in interface LogMetricOrBuilder

setName

public LogMetric.Builder setName(java.lang.String value)

 Required. The client-assigned metric identifier.
 Examples: `"error_count"`, `"nginx/requests"`.
 Metric identifiers are limited to 100 characters and can include
 only the following characters: `A-Z`, `a-z`, `0-9`, and the
 special characters `_-.,+!*',()%/`.  The forward-slash character
 (`/`) denotes a hierarchy of name pieces, and it cannot be the
 first character of the name.
 The metric identifier in this field must not be
 [URL-encoded](https://en.wikipedia.org/wiki/Percent-encoding).
 However, when the metric identifier appears as the `[METRIC_ID]`
 part of a `metric_name` API parameter, then the metric identifier
 must be URL-encoded. Example:
 `"projects/my-project/metrics/nginx%2Frequests"`.

string name = 1;

clearName

public LogMetric.Builder clearName()

 Required. The client-assigned metric identifier.
 Examples: `"error_count"`, `"nginx/requests"`.
 Metric identifiers are limited to 100 characters and can include
 only the following characters: `A-Z`, `a-z`, `0-9`, and the
 special characters `_-.,+!*',()%/`.  The forward-slash character
 (`/`) denotes a hierarchy of name pieces, and it cannot be the
 first character of the name.
 The metric identifier in this field must not be
 [URL-encoded](https://en.wikipedia.org/wiki/Percent-encoding).
 However, when the metric identifier appears as the `[METRIC_ID]`
 part of a `metric_name` API parameter, then the metric identifier
 must be URL-encoded. Example:
 `"projects/my-project/metrics/nginx%2Frequests"`.

string name = 1;

setNameBytes

public LogMetric.Builder setNameBytes(com.google.protobuf.ByteString value)

 Required. The client-assigned metric identifier.
 Examples: `"error_count"`, `"nginx/requests"`.
 Metric identifiers are limited to 100 characters and can include
 only the following characters: `A-Z`, `a-z`, `0-9`, and the
 special characters `_-.,+!*',()%/`.  The forward-slash character
 (`/`) denotes a hierarchy of name pieces, and it cannot be the
 first character of the name.
 The metric identifier in this field must not be
 [URL-encoded](https://en.wikipedia.org/wiki/Percent-encoding).
 However, when the metric identifier appears as the `[METRIC_ID]`
 part of a `metric_name` API parameter, then the metric identifier
 must be URL-encoded. Example:
 `"projects/my-project/metrics/nginx%2Frequests"`.

string name = 1;

getDescription

public java.lang.String getDescription()

 Optional. A description of this metric, which is used in documentation.

string description = 2;

Specified by:: getDescription in interface LogMetricOrBuilder

getDescriptionBytes

public com.google.protobuf.ByteString getDescriptionBytes()

 Optional. A description of this metric, which is used in documentation.

string description = 2;

Specified by:: getDescriptionBytes in interface LogMetricOrBuilder

setDescription

public LogMetric.Builder setDescription(java.lang.String value)

 Optional. A description of this metric, which is used in documentation.

string description = 2;

clearDescription

public LogMetric.Builder clearDescription()

 Optional. A description of this metric, which is used in documentation.

string description = 2;

setDescriptionBytes

public LogMetric.Builder setDescriptionBytes(com.google.protobuf.ByteString value)

 Optional. A description of this metric, which is used in documentation.

string description = 2;

getFilter

public java.lang.String getFilter()

 Required. An [advanced logs filter](/logging/docs/view/advanced_filters)
 which is used to match log entries.
 Example:
     "resource.type=gae_app AND severity>=ERROR"
 The maximum length of the filter is 20000 characters.

string filter = 3;

Specified by:: getFilter in interface LogMetricOrBuilder

getFilterBytes

public com.google.protobuf.ByteString getFilterBytes()

 Required. An [advanced logs filter](/logging/docs/view/advanced_filters)
 which is used to match log entries.
 Example:
     "resource.type=gae_app AND severity>=ERROR"
 The maximum length of the filter is 20000 characters.

string filter = 3;

Specified by:: getFilterBytes in interface LogMetricOrBuilder

setFilter

public LogMetric.Builder setFilter(java.lang.String value)

 Required. An [advanced logs filter](/logging/docs/view/advanced_filters)
 which is used to match log entries.
 Example:
     "resource.type=gae_app AND severity>=ERROR"
 The maximum length of the filter is 20000 characters.

string filter = 3;

clearFilter

public LogMetric.Builder clearFilter()

 Required. An [advanced logs filter](/logging/docs/view/advanced_filters)
 which is used to match log entries.
 Example:
     "resource.type=gae_app AND severity>=ERROR"
 The maximum length of the filter is 20000 characters.

string filter = 3;

setFilterBytes

public LogMetric.Builder setFilterBytes(com.google.protobuf.ByteString value)

 Required. An [advanced logs filter](/logging/docs/view/advanced_filters)
 which is used to match log entries.
 Example:
     "resource.type=gae_app AND severity>=ERROR"
 The maximum length of the filter is 20000 characters.

string filter = 3;