Class PredictRequestResponseLoggingConfig.Builder (3.64.0)

public static final class PredictRequestResponseLoggingConfig.Builder extends GeneratedMessageV3.Builder<PredictRequestResponseLoggingConfig.Builder> implements PredictRequestResponseLoggingConfigOrBuilder

Configuration for logging request-response to a BigQuery table.

Protobuf type google.cloud.aiplatform.v1beta1.PredictRequestResponseLoggingConfig

Static Methods

getDescriptor()

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

Methods

addRepeatedField(Descriptors.FieldDescriptor field, Object value)

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

build()

public PredictRequestResponseLoggingConfig build()
Returns
Type Description
PredictRequestResponseLoggingConfig

buildPartial()

public PredictRequestResponseLoggingConfig buildPartial()
Returns
Type Description
PredictRequestResponseLoggingConfig

clear()

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

clearBigqueryDestination()

public PredictRequestResponseLoggingConfig.Builder clearBigqueryDestination()

BigQuery table for logging. If only given a project, a new dataset will be created with name logging_<endpoint-display-name>_<endpoint-id> where <endpoint-display-name> will be made BigQuery-dataset-name compatible (e.g. most special characters will become underscores). If no table name is given, a new table will be created with name request_response_logging

.google.cloud.aiplatform.v1beta1.BigQueryDestination bigquery_destination = 3;

Returns
Type Description
PredictRequestResponseLoggingConfig.Builder

clearEnableOtelLogging()

public PredictRequestResponseLoggingConfig.Builder clearEnableOtelLogging()

This field is used for large models. If true, in addition to the original large model logs, logs will be converted in OTel schema format, and saved in otel_log column. Default value is false.

bool enable_otel_logging = 6;

Returns
Type Description
PredictRequestResponseLoggingConfig.Builder

This builder for chaining.

clearEnabled()

public PredictRequestResponseLoggingConfig.Builder clearEnabled()

If logging is enabled or not.

bool enabled = 1;

Returns
Type Description
PredictRequestResponseLoggingConfig.Builder

This builder for chaining.

clearField(Descriptors.FieldDescriptor field)

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

clearOneof(Descriptors.OneofDescriptor oneof)

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

clearRequestResponseLoggingSchemaVersion()

public PredictRequestResponseLoggingConfig.Builder clearRequestResponseLoggingSchemaVersion()

Output only. The schema version used in creating the BigQuery table for the request response logging. The versions are "v1" and "v2". The current default version is "v1".

string request_response_logging_schema_version = 4 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
PredictRequestResponseLoggingConfig.Builder

This builder for chaining.

clearSamplingRate()

public PredictRequestResponseLoggingConfig.Builder clearSamplingRate()

Percentage of requests to be logged, expressed as a fraction in range(0,1].

double sampling_rate = 2;

Returns
Type Description
PredictRequestResponseLoggingConfig.Builder

This builder for chaining.

clone()

public PredictRequestResponseLoggingConfig.Builder clone()
Returns
Type Description
PredictRequestResponseLoggingConfig.Builder
Overrides

getBigqueryDestination()

public BigQueryDestination getBigqueryDestination()

BigQuery table for logging. If only given a project, a new dataset will be created with name logging_<endpoint-display-name>_<endpoint-id> where <endpoint-display-name> will be made BigQuery-dataset-name compatible (e.g. most special characters will become underscores). If no table name is given, a new table will be created with name request_response_logging

.google.cloud.aiplatform.v1beta1.BigQueryDestination bigquery_destination = 3;

Returns
Type Description
BigQueryDestination

The bigqueryDestination.

getBigqueryDestinationBuilder()

public BigQueryDestination.Builder getBigqueryDestinationBuilder()

BigQuery table for logging. If only given a project, a new dataset will be created with name logging_<endpoint-display-name>_<endpoint-id> where <endpoint-display-name> will be made BigQuery-dataset-name compatible (e.g. most special characters will become underscores). If no table name is given, a new table will be created with name request_response_logging

.google.cloud.aiplatform.v1beta1.BigQueryDestination bigquery_destination = 3;

Returns
Type Description
BigQueryDestination.Builder

getBigqueryDestinationOrBuilder()

public BigQueryDestinationOrBuilder getBigqueryDestinationOrBuilder()

BigQuery table for logging. If only given a project, a new dataset will be created with name logging_<endpoint-display-name>_<endpoint-id> where <endpoint-display-name> will be made BigQuery-dataset-name compatible (e.g. most special characters will become underscores). If no table name is given, a new table will be created with name request_response_logging

.google.cloud.aiplatform.v1beta1.BigQueryDestination bigquery_destination = 3;

Returns
Type Description
BigQueryDestinationOrBuilder

getDefaultInstanceForType()

public PredictRequestResponseLoggingConfig getDefaultInstanceForType()
Returns
Type Description
PredictRequestResponseLoggingConfig

getDescriptorForType()

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

getEnableOtelLogging()

public boolean getEnableOtelLogging()

This field is used for large models. If true, in addition to the original large model logs, logs will be converted in OTel schema format, and saved in otel_log column. Default value is false.

bool enable_otel_logging = 6;

Returns
Type Description
boolean

The enableOtelLogging.

getEnabled()

public boolean getEnabled()

If logging is enabled or not.

bool enabled = 1;

Returns
Type Description
boolean

The enabled.

getRequestResponseLoggingSchemaVersion()

public String getRequestResponseLoggingSchemaVersion()

Output only. The schema version used in creating the BigQuery table for the request response logging. The versions are "v1" and "v2". The current default version is "v1".

string request_response_logging_schema_version = 4 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
String

The requestResponseLoggingSchemaVersion.

getRequestResponseLoggingSchemaVersionBytes()

public ByteString getRequestResponseLoggingSchemaVersionBytes()

Output only. The schema version used in creating the BigQuery table for the request response logging. The versions are "v1" and "v2". The current default version is "v1".

string request_response_logging_schema_version = 4 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
ByteString

The bytes for requestResponseLoggingSchemaVersion.

getSamplingRate()

public double getSamplingRate()

Percentage of requests to be logged, expressed as a fraction in range(0,1].

double sampling_rate = 2;

Returns
Type Description
double

The samplingRate.

hasBigqueryDestination()

public boolean hasBigqueryDestination()

BigQuery table for logging. If only given a project, a new dataset will be created with name logging_<endpoint-display-name>_<endpoint-id> where <endpoint-display-name> will be made BigQuery-dataset-name compatible (e.g. most special characters will become underscores). If no table name is given, a new table will be created with name request_response_logging

.google.cloud.aiplatform.v1beta1.BigQueryDestination bigquery_destination = 3;

Returns
Type Description
boolean

Whether the bigqueryDestination field is set.

internalGetFieldAccessorTable()

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

isInitialized()

public final boolean isInitialized()
Returns
Type Description
boolean
Overrides

mergeBigqueryDestination(BigQueryDestination value)

public PredictRequestResponseLoggingConfig.Builder mergeBigqueryDestination(BigQueryDestination value)

BigQuery table for logging. If only given a project, a new dataset will be created with name logging_<endpoint-display-name>_<endpoint-id> where <endpoint-display-name> will be made BigQuery-dataset-name compatible (e.g. most special characters will become underscores). If no table name is given, a new table will be created with name request_response_logging

.google.cloud.aiplatform.v1beta1.BigQueryDestination bigquery_destination = 3;

Parameter
Name Description
value BigQueryDestination
Returns
Type Description
PredictRequestResponseLoggingConfig.Builder

mergeFrom(PredictRequestResponseLoggingConfig other)

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

mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

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

mergeFrom(Message other)

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

mergeUnknownFields(UnknownFieldSet unknownFields)

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

setBigqueryDestination(BigQueryDestination value)

public PredictRequestResponseLoggingConfig.Builder setBigqueryDestination(BigQueryDestination value)

BigQuery table for logging. If only given a project, a new dataset will be created with name logging_<endpoint-display-name>_<endpoint-id> where <endpoint-display-name> will be made BigQuery-dataset-name compatible (e.g. most special characters will become underscores). If no table name is given, a new table will be created with name request_response_logging

.google.cloud.aiplatform.v1beta1.BigQueryDestination bigquery_destination = 3;

Parameter
Name Description
value BigQueryDestination
Returns
Type Description
PredictRequestResponseLoggingConfig.Builder

setBigqueryDestination(BigQueryDestination.Builder builderForValue)

public PredictRequestResponseLoggingConfig.Builder setBigqueryDestination(BigQueryDestination.Builder builderForValue)

BigQuery table for logging. If only given a project, a new dataset will be created with name logging_<endpoint-display-name>_<endpoint-id> where <endpoint-display-name> will be made BigQuery-dataset-name compatible (e.g. most special characters will become underscores). If no table name is given, a new table will be created with name request_response_logging

.google.cloud.aiplatform.v1beta1.BigQueryDestination bigquery_destination = 3;

Parameter
Name Description
builderForValue BigQueryDestination.Builder
Returns
Type Description
PredictRequestResponseLoggingConfig.Builder

setEnableOtelLogging(boolean value)

public PredictRequestResponseLoggingConfig.Builder setEnableOtelLogging(boolean value)

This field is used for large models. If true, in addition to the original large model logs, logs will be converted in OTel schema format, and saved in otel_log column. Default value is false.

bool enable_otel_logging = 6;

Parameter
Name Description
value boolean

The enableOtelLogging to set.

Returns
Type Description
PredictRequestResponseLoggingConfig.Builder

This builder for chaining.

setEnabled(boolean value)

public PredictRequestResponseLoggingConfig.Builder setEnabled(boolean value)

If logging is enabled or not.

bool enabled = 1;

Parameter
Name Description
value boolean

The enabled to set.

Returns
Type Description
PredictRequestResponseLoggingConfig.Builder

This builder for chaining.

setField(Descriptors.FieldDescriptor field, Object value)

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

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

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

setRequestResponseLoggingSchemaVersion(String value)

public PredictRequestResponseLoggingConfig.Builder setRequestResponseLoggingSchemaVersion(String value)

Output only. The schema version used in creating the BigQuery table for the request response logging. The versions are "v1" and "v2". The current default version is "v1".

string request_response_logging_schema_version = 4 [(.google.api.field_behavior) = OUTPUT_ONLY];

Parameter
Name Description
value String

The requestResponseLoggingSchemaVersion to set.

Returns
Type Description
PredictRequestResponseLoggingConfig.Builder

This builder for chaining.

setRequestResponseLoggingSchemaVersionBytes(ByteString value)

public PredictRequestResponseLoggingConfig.Builder setRequestResponseLoggingSchemaVersionBytes(ByteString value)

Output only. The schema version used in creating the BigQuery table for the request response logging. The versions are "v1" and "v2". The current default version is "v1".

string request_response_logging_schema_version = 4 [(.google.api.field_behavior) = OUTPUT_ONLY];

Parameter
Name Description
value ByteString

The bytes for requestResponseLoggingSchemaVersion to set.

Returns
Type Description
PredictRequestResponseLoggingConfig.Builder

This builder for chaining.

setSamplingRate(double value)

public PredictRequestResponseLoggingConfig.Builder setSamplingRate(double value)

Percentage of requests to be logged, expressed as a fraction in range(0,1].

double sampling_rate = 2;

Parameter
Name Description
value double

The samplingRate to set.

Returns
Type Description
PredictRequestResponseLoggingConfig.Builder

This builder for chaining.

setUnknownFields(UnknownFieldSet unknownFields)

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