com.google.api.services.retail.v2.model.GoogleCloudRetailLoggingErrorLog Maven / Gradle / Ivy
The newest version!
/*
* Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except
* in compliance with the License. You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software distributed under the License
* is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express
* or implied. See the License for the specific language governing permissions and limitations under
* the License.
*/
/*
* This code was generated by https://github.com/googleapis/google-api-java-client-services/
* Modify at your own risk.
*/
package com.google.api.services.retail.v2.model;
/**
* An error log which is reported to the Error Reporting system. This proto a superset of
* google.devtools.clouderrorreporting.v1beta1.ReportedErrorEvent.
*
* This is the Java data model class that specifies how to parse/serialize into the JSON that is
* transmitted over HTTP when working with the Vertex AI Search for Retail API. For a detailed
* explanation see:
* https://developers.google.com/api-client-library/java/google-http-java-client/json
*
*
* @author Google, Inc.
*/
@SuppressWarnings("javadoc")
public final class GoogleCloudRetailLoggingErrorLog extends com.google.api.client.json.GenericJson {
/**
* A description of the context in which the error occurred.
* The value may be {@code null}.
*/
@com.google.api.client.util.Key
private GoogleCloudRetailLoggingErrorContext context;
/**
* The error payload that is populated on LRO import APIs.
* The value may be {@code null}.
*/
@com.google.api.client.util.Key
private GoogleCloudRetailLoggingImportErrorContext importPayload;
/**
* A message describing the error.
* The value may be {@code null}.
*/
@com.google.api.client.util.Key
private java.lang.String message;
/**
* The API request payload, represented as a protocol buffer. Most API request types are
* supported. For example:
* "type.googleapis.com/google.cloud.retail.v2.ProductService.CreateProductRequest"
* "type.googleapis.com/google.cloud.retail.v2.UserEventService.WriteUserEventRequest"
* The value may be {@code null}.
*/
@com.google.api.client.util.Key
private java.util.Map requestPayload;
/**
* The API response payload, represented as a protocol buffer. This is used to log some "soft
* errors", where the response is valid but we consider there are some quality issues like
* unjoined events. The following API responses are supported and no PII is included:
* "google.cloud.retail.v2.PredictionService.Predict"
* "google.cloud.retail.v2.UserEventService.WriteUserEvent"
* "google.cloud.retail.v2.UserEventService.CollectUserEvent"
* The value may be {@code null}.
*/
@com.google.api.client.util.Key
private java.util.Map responsePayload;
/**
* The service context in which this error has occurred.
* The value may be {@code null}.
*/
@com.google.api.client.util.Key
private GoogleCloudRetailLoggingServiceContext serviceContext;
/**
* The RPC status associated with the error log.
* The value may be {@code null}.
*/
@com.google.api.client.util.Key
private GoogleRpcStatus status;
/**
* A description of the context in which the error occurred.
* @return value or {@code null} for none
*/
public GoogleCloudRetailLoggingErrorContext getContext() {
return context;
}
/**
* A description of the context in which the error occurred.
* @param context context or {@code null} for none
*/
public GoogleCloudRetailLoggingErrorLog setContext(GoogleCloudRetailLoggingErrorContext context) {
this.context = context;
return this;
}
/**
* The error payload that is populated on LRO import APIs.
* @return value or {@code null} for none
*/
public GoogleCloudRetailLoggingImportErrorContext getImportPayload() {
return importPayload;
}
/**
* The error payload that is populated on LRO import APIs.
* @param importPayload importPayload or {@code null} for none
*/
public GoogleCloudRetailLoggingErrorLog setImportPayload(GoogleCloudRetailLoggingImportErrorContext importPayload) {
this.importPayload = importPayload;
return this;
}
/**
* A message describing the error.
* @return value or {@code null} for none
*/
public java.lang.String getMessage() {
return message;
}
/**
* A message describing the error.
* @param message message or {@code null} for none
*/
public GoogleCloudRetailLoggingErrorLog setMessage(java.lang.String message) {
this.message = message;
return this;
}
/**
* The API request payload, represented as a protocol buffer. Most API request types are
* supported. For example:
* "type.googleapis.com/google.cloud.retail.v2.ProductService.CreateProductRequest"
* "type.googleapis.com/google.cloud.retail.v2.UserEventService.WriteUserEventRequest"
* @return value or {@code null} for none
*/
public java.util.Map getRequestPayload() {
return requestPayload;
}
/**
* The API request payload, represented as a protocol buffer. Most API request types are
* supported. For example:
* "type.googleapis.com/google.cloud.retail.v2.ProductService.CreateProductRequest"
* "type.googleapis.com/google.cloud.retail.v2.UserEventService.WriteUserEventRequest"
* @param requestPayload requestPayload or {@code null} for none
*/
public GoogleCloudRetailLoggingErrorLog setRequestPayload(java.util.Map requestPayload) {
this.requestPayload = requestPayload;
return this;
}
/**
* The API response payload, represented as a protocol buffer. This is used to log some "soft
* errors", where the response is valid but we consider there are some quality issues like
* unjoined events. The following API responses are supported and no PII is included:
* "google.cloud.retail.v2.PredictionService.Predict"
* "google.cloud.retail.v2.UserEventService.WriteUserEvent"
* "google.cloud.retail.v2.UserEventService.CollectUserEvent"
* @return value or {@code null} for none
*/
public java.util.Map getResponsePayload() {
return responsePayload;
}
/**
* The API response payload, represented as a protocol buffer. This is used to log some "soft
* errors", where the response is valid but we consider there are some quality issues like
* unjoined events. The following API responses are supported and no PII is included:
* "google.cloud.retail.v2.PredictionService.Predict"
* "google.cloud.retail.v2.UserEventService.WriteUserEvent"
* "google.cloud.retail.v2.UserEventService.CollectUserEvent"
* @param responsePayload responsePayload or {@code null} for none
*/
public GoogleCloudRetailLoggingErrorLog setResponsePayload(java.util.Map responsePayload) {
this.responsePayload = responsePayload;
return this;
}
/**
* The service context in which this error has occurred.
* @return value or {@code null} for none
*/
public GoogleCloudRetailLoggingServiceContext getServiceContext() {
return serviceContext;
}
/**
* The service context in which this error has occurred.
* @param serviceContext serviceContext or {@code null} for none
*/
public GoogleCloudRetailLoggingErrorLog setServiceContext(GoogleCloudRetailLoggingServiceContext serviceContext) {
this.serviceContext = serviceContext;
return this;
}
/**
* The RPC status associated with the error log.
* @return value or {@code null} for none
*/
public GoogleRpcStatus getStatus() {
return status;
}
/**
* The RPC status associated with the error log.
* @param status status or {@code null} for none
*/
public GoogleCloudRetailLoggingErrorLog setStatus(GoogleRpcStatus status) {
this.status = status;
return this;
}
@Override
public GoogleCloudRetailLoggingErrorLog set(String fieldName, Object value) {
return (GoogleCloudRetailLoggingErrorLog) super.set(fieldName, value);
}
@Override
public GoogleCloudRetailLoggingErrorLog clone() {
return (GoogleCloudRetailLoggingErrorLog) super.clone();
}
}
© 2015 - 2025 Weber Informatics LLC | Privacy Policy