|
| 1 | +/* |
| 2 | + * Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except |
| 3 | + * in compliance with the License. You may obtain a copy of the License at |
| 4 | + * |
| 5 | + * http://www.apache.org/licenses/LICENSE-2.0 |
| 6 | + * |
| 7 | + * Unless required by applicable law or agreed to in writing, software distributed under the License |
| 8 | + * is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express |
| 9 | + * or implied. See the License for the specific language governing permissions and limitations under |
| 10 | + * the License. |
| 11 | + */ |
| 12 | +/* |
| 13 | + * This code was generated by https://github.com/googleapis/google-api-java-client-services/ |
| 14 | + * Modify at your own risk. |
| 15 | + */ |
| 16 | + |
| 17 | +package com.google.api.services.retail.v2alpha.model; |
| 18 | + |
| 19 | +/** |
| 20 | + * Request message for the `ExportUserEvents` method. |
| 21 | + * |
| 22 | + * <p> This is the Java data model class that specifies how to parse/serialize into the JSON that is |
| 23 | + * transmitted over HTTP when working with the Vertex AI Search for Retail API. For a detailed |
| 24 | + * explanation see: |
| 25 | + * <a href="https://developers.google.com/api-client-library/java/google-http-java-client/json">https://developers.google.com/api-client-library/java/google-http-java-client/json</a> |
| 26 | + * </p> |
| 27 | + * |
| 28 | + * @author Google, Inc. |
| 29 | + */ |
| 30 | +@SuppressWarnings("javadoc") |
| 31 | +public final class GoogleCloudRetailV2alphaExportUserEventsRequest extends com.google.api.client.json.GenericJson { |
| 32 | + |
| 33 | + /** |
| 34 | + * A filtering expression to specify restrictions on returned events. The expression is a sequence |
| 35 | + * of terms. Each term applies a restriction to the returned user events. Use this expression to |
| 36 | + * restrict results to a specific time range or to filter events by eventType. For example, |
| 37 | + * `eventTime > "2012-04-23T18:25:43.511Z" eventsMissingCatalogItems |
| 38 | + * eventTime<"2012-04-23T18:25:43.511Z" eventType=search` We expect only three types of fields: * |
| 39 | + * `eventTime`: This can be specified twice, once with a less than operator and once with a |
| 40 | + * greater than operator. The `eventTime` restriction should result in one, contiguous, valid, |
| 41 | + * `eventTime` range. * `eventType`: Boolean operators `OR` and `NOT` are supported if the |
| 42 | + * expression is enclosed in parentheses and the operators are separated from the tag values by a |
| 43 | + * space. * `eventsMissingCatalogItems`: This restricts results to events for which catalog items |
| 44 | + * were not found in the catalog. The default behavior is to return only those events for which |
| 45 | + * catalog items were found. Some examples of valid filters expressions: * Example 1: `eventTime > |
| 46 | + * "2012-04-23T18:25:43.511Z" eventTime < "2012-04-23T18:30:43.511Z"` * Example 2: `eventTime > |
| 47 | + * "2012-04-23T18:25:43.511Z" eventType = detail-page-view` * Example 3: |
| 48 | + * `eventsMissingCatalogItems eventType = (NOT search) eventTime < "2018-04-23T18:30:43.511Z"` * |
| 49 | + * Example 4: `eventTime > "2012-04-23T18:25:43.511Z"` * Example 5: `eventType = (detail-page-view |
| 50 | + * OR search)` * Example 6: `eventsMissingCatalogItems` |
| 51 | + * The value may be {@code null}. |
| 52 | + */ |
| 53 | + @com.google.api.client.util.Key |
| 54 | + private java.lang.String filter; |
| 55 | + |
| 56 | + /** |
| 57 | + * Required. The output location of the data. |
| 58 | + * The value may be {@code null}. |
| 59 | + */ |
| 60 | + @com.google.api.client.util.Key |
| 61 | + private GoogleCloudRetailV2alphaOutputConfig outputConfig; |
| 62 | + |
| 63 | + /** |
| 64 | + * A filtering expression to specify restrictions on returned events. The expression is a sequence |
| 65 | + * of terms. Each term applies a restriction to the returned user events. Use this expression to |
| 66 | + * restrict results to a specific time range or to filter events by eventType. For example, |
| 67 | + * `eventTime > "2012-04-23T18:25:43.511Z" eventsMissingCatalogItems |
| 68 | + * eventTime<"2012-04-23T18:25:43.511Z" eventType=search` We expect only three types of fields: * |
| 69 | + * `eventTime`: This can be specified twice, once with a less than operator and once with a |
| 70 | + * greater than operator. The `eventTime` restriction should result in one, contiguous, valid, |
| 71 | + * `eventTime` range. * `eventType`: Boolean operators `OR` and `NOT` are supported if the |
| 72 | + * expression is enclosed in parentheses and the operators are separated from the tag values by a |
| 73 | + * space. * `eventsMissingCatalogItems`: This restricts results to events for which catalog items |
| 74 | + * were not found in the catalog. The default behavior is to return only those events for which |
| 75 | + * catalog items were found. Some examples of valid filters expressions: * Example 1: `eventTime > |
| 76 | + * "2012-04-23T18:25:43.511Z" eventTime < "2012-04-23T18:30:43.511Z"` * Example 2: `eventTime > |
| 77 | + * "2012-04-23T18:25:43.511Z" eventType = detail-page-view` * Example 3: |
| 78 | + * `eventsMissingCatalogItems eventType = (NOT search) eventTime < "2018-04-23T18:30:43.511Z"` * |
| 79 | + * Example 4: `eventTime > "2012-04-23T18:25:43.511Z"` * Example 5: `eventType = (detail-page-view |
| 80 | + * OR search)` * Example 6: `eventsMissingCatalogItems` |
| 81 | + * @return value or {@code null} for none |
| 82 | + */ |
| 83 | + public java.lang.String getFilter() { |
| 84 | + return filter; |
| 85 | + } |
| 86 | + |
| 87 | + /** |
| 88 | + * A filtering expression to specify restrictions on returned events. The expression is a sequence |
| 89 | + * of terms. Each term applies a restriction to the returned user events. Use this expression to |
| 90 | + * restrict results to a specific time range or to filter events by eventType. For example, |
| 91 | + * `eventTime > "2012-04-23T18:25:43.511Z" eventsMissingCatalogItems |
| 92 | + * eventTime<"2012-04-23T18:25:43.511Z" eventType=search` We expect only three types of fields: * |
| 93 | + * `eventTime`: This can be specified twice, once with a less than operator and once with a |
| 94 | + * greater than operator. The `eventTime` restriction should result in one, contiguous, valid, |
| 95 | + * `eventTime` range. * `eventType`: Boolean operators `OR` and `NOT` are supported if the |
| 96 | + * expression is enclosed in parentheses and the operators are separated from the tag values by a |
| 97 | + * space. * `eventsMissingCatalogItems`: This restricts results to events for which catalog items |
| 98 | + * were not found in the catalog. The default behavior is to return only those events for which |
| 99 | + * catalog items were found. Some examples of valid filters expressions: * Example 1: `eventTime > |
| 100 | + * "2012-04-23T18:25:43.511Z" eventTime < "2012-04-23T18:30:43.511Z"` * Example 2: `eventTime > |
| 101 | + * "2012-04-23T18:25:43.511Z" eventType = detail-page-view` * Example 3: |
| 102 | + * `eventsMissingCatalogItems eventType = (NOT search) eventTime < "2018-04-23T18:30:43.511Z"` * |
| 103 | + * Example 4: `eventTime > "2012-04-23T18:25:43.511Z"` * Example 5: `eventType = (detail-page-view |
| 104 | + * OR search)` * Example 6: `eventsMissingCatalogItems` |
| 105 | + * @param filter filter or {@code null} for none |
| 106 | + */ |
| 107 | + public GoogleCloudRetailV2alphaExportUserEventsRequest setFilter(java.lang.String filter) { |
| 108 | + this.filter = filter; |
| 109 | + return this; |
| 110 | + } |
| 111 | + |
| 112 | + /** |
| 113 | + * Required. The output location of the data. |
| 114 | + * @return value or {@code null} for none |
| 115 | + */ |
| 116 | + public GoogleCloudRetailV2alphaOutputConfig getOutputConfig() { |
| 117 | + return outputConfig; |
| 118 | + } |
| 119 | + |
| 120 | + /** |
| 121 | + * Required. The output location of the data. |
| 122 | + * @param outputConfig outputConfig or {@code null} for none |
| 123 | + */ |
| 124 | + public GoogleCloudRetailV2alphaExportUserEventsRequest setOutputConfig(GoogleCloudRetailV2alphaOutputConfig outputConfig) { |
| 125 | + this.outputConfig = outputConfig; |
| 126 | + return this; |
| 127 | + } |
| 128 | + |
| 129 | + @Override |
| 130 | + public GoogleCloudRetailV2alphaExportUserEventsRequest set(String fieldName, Object value) { |
| 131 | + return (GoogleCloudRetailV2alphaExportUserEventsRequest) super.set(fieldName, value); |
| 132 | + } |
| 133 | + |
| 134 | + @Override |
| 135 | + public GoogleCloudRetailV2alphaExportUserEventsRequest clone() { |
| 136 | + return (GoogleCloudRetailV2alphaExportUserEventsRequest) super.clone(); |
| 137 | + } |
| 138 | + |
| 139 | +} |
0 commit comments