Class LoggingConfig (2.55.0)

public final class LoggingConfig extends GeneratedMessageV3 implements LoggingConfigOrBuilder

Project level logging config to control what level of log will be generated and written to Cloud Logging.

Protobuf type google.cloud.retail.v2alpha.LoggingConfig

Static Fields

DEFAULT_LOG_GENERATION_RULE_FIELD_NUMBER

public static final int DEFAULT_LOG_GENERATION_RULE_FIELD_NUMBER
Field Value
Type Description
int

NAME_FIELD_NUMBER

public static final int NAME_FIELD_NUMBER
Field Value
Type Description
int

SERVICE_LOG_GENERATION_RULES_FIELD_NUMBER

public static final int SERVICE_LOG_GENERATION_RULES_FIELD_NUMBER
Field Value
Type Description
int

Static Methods

getDefaultInstance()

public static LoggingConfig getDefaultInstance()
Returns
Type Description
LoggingConfig

getDescriptor()

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

newBuilder()

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

newBuilder(LoggingConfig prototype)

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

parseDelimitedFrom(InputStream input)

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

parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

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

parseFrom(byte[] data)

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

parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)

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

parseFrom(ByteString data)

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

parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)

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

parseFrom(CodedInputStream input)

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

parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

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

parseFrom(InputStream input)

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

parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

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

parseFrom(ByteBuffer data)

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

parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)

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

parser()

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

Methods

equals(Object obj)

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

getDefaultInstanceForType()

public LoggingConfig getDefaultInstanceForType()
Returns
Type Description
LoggingConfig

getDefaultLogGenerationRule()

public LoggingConfig.LogGenerationRule getDefaultLogGenerationRule()

The log generation rule that applies by default to all services supporting log generation. It can be overridden by ServiceLogGenerationRule for service level control.

.google.cloud.retail.v2alpha.LoggingConfig.LogGenerationRule default_log_generation_rule = 2;

Returns
Type Description
LoggingConfig.LogGenerationRule

The defaultLogGenerationRule.

getDefaultLogGenerationRuleOrBuilder()

public LoggingConfig.LogGenerationRuleOrBuilder getDefaultLogGenerationRuleOrBuilder()

The log generation rule that applies by default to all services supporting log generation. It can be overridden by ServiceLogGenerationRule for service level control.

.google.cloud.retail.v2alpha.LoggingConfig.LogGenerationRule default_log_generation_rule = 2;

Returns
Type Description
LoggingConfig.LogGenerationRuleOrBuilder

getName()

public String getName()

Required. Immutable. The name of the LoggingConfig singleton resource. Format: projects/*/loggingConfig

string name = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.field_behavior) = IMMUTABLE];

Returns
Type Description
String

The name.

getNameBytes()

public ByteString getNameBytes()

Required. Immutable. The name of the LoggingConfig singleton resource. Format: projects/*/loggingConfig

string name = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.field_behavior) = IMMUTABLE];

Returns
Type Description
ByteString

The bytes for name.

getParserForType()

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

getSerializedSize()

public int getSerializedSize()
Returns
Type Description
int
Overrides

getServiceLogGenerationRules(int index)

public LoggingConfig.ServiceLogGenerationRule getServiceLogGenerationRules(int index)

Controls logging configurations more granularly for each supported service.

This overrides the default_log_generation_rule for the services specified. For those not mentioned, they will fallback to the default log generation rule.

repeated .google.cloud.retail.v2alpha.LoggingConfig.ServiceLogGenerationRule service_log_generation_rules = 4;

Parameter
Name Description
index int
Returns
Type Description
LoggingConfig.ServiceLogGenerationRule

getServiceLogGenerationRulesCount()

public int getServiceLogGenerationRulesCount()

Controls logging configurations more granularly for each supported service.

This overrides the default_log_generation_rule for the services specified. For those not mentioned, they will fallback to the default log generation rule.

repeated .google.cloud.retail.v2alpha.LoggingConfig.ServiceLogGenerationRule service_log_generation_rules = 4;

Returns
Type Description
int

getServiceLogGenerationRulesList()

public List<LoggingConfig.ServiceLogGenerationRule> getServiceLogGenerationRulesList()

Controls logging configurations more granularly for each supported service.

This overrides the default_log_generation_rule for the services specified. For those not mentioned, they will fallback to the default log generation rule.

repeated .google.cloud.retail.v2alpha.LoggingConfig.ServiceLogGenerationRule service_log_generation_rules = 4;

Returns
Type Description
List<ServiceLogGenerationRule>

getServiceLogGenerationRulesOrBuilder(int index)

public LoggingConfig.ServiceLogGenerationRuleOrBuilder getServiceLogGenerationRulesOrBuilder(int index)

Controls logging configurations more granularly for each supported service.

This overrides the default_log_generation_rule for the services specified. For those not mentioned, they will fallback to the default log generation rule.

repeated .google.cloud.retail.v2alpha.LoggingConfig.ServiceLogGenerationRule service_log_generation_rules = 4;

Parameter
Name Description
index int
Returns
Type Description
LoggingConfig.ServiceLogGenerationRuleOrBuilder

getServiceLogGenerationRulesOrBuilderList()

public List<? extends LoggingConfig.ServiceLogGenerationRuleOrBuilder> getServiceLogGenerationRulesOrBuilderList()

Controls logging configurations more granularly for each supported service.

This overrides the default_log_generation_rule for the services specified. For those not mentioned, they will fallback to the default log generation rule.

repeated .google.cloud.retail.v2alpha.LoggingConfig.ServiceLogGenerationRule service_log_generation_rules = 4;

Returns
Type Description
List<? extends com.google.cloud.retail.v2alpha.LoggingConfig.ServiceLogGenerationRuleOrBuilder>

hasDefaultLogGenerationRule()

public boolean hasDefaultLogGenerationRule()

The log generation rule that applies by default to all services supporting log generation. It can be overridden by ServiceLogGenerationRule for service level control.

.google.cloud.retail.v2alpha.LoggingConfig.LogGenerationRule default_log_generation_rule = 2;

Returns
Type Description
boolean

Whether the defaultLogGenerationRule field is set.

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 LoggingConfig.Builder newBuilderForType()
Returns
Type Description
LoggingConfig.Builder

newBuilderForType(GeneratedMessageV3.BuilderParent parent)

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

newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)

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

toBuilder()

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

writeTo(CodedOutputStream output)

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