{@link GetCompletionConfig#initialize(com.google.api.client.googleapis.services. + * AbstractGoogleClientRequest)} must be called to initialize this instance immediately after + * invoking the constructor.
+ * + * @param name Required. Full CompletionConfig resource name. Format: + * `projects/locations/dataStores/completionConfig` + * `projects/locations/collections/dataStores/completionConfig` + * `projects/locations/collections/engines/completionConfig` + * @since 1.13 + */ + protected GetCompletionConfig(java.lang.String name) { + super(DiscoveryEngine.this, "GET", REST_PATH, null, com.google.api.services.discoveryengine.v1alpha.model.GoogleCloudDiscoveryengineV1alphaCompletionConfig.class); + this.name = com.google.api.client.util.Preconditions.checkNotNull(name, "Required parameter name must be specified."); + if (!getSuppressPatternChecks()) { + com.google.api.client.util.Preconditions.checkArgument(NAME_PATTERN.matcher(name).matches(), + "Parameter name must conform to the pattern " + + "^projects/[^/]+/locations/[^/]+/collections/[^/]+/dataStores/[^/]+/completionConfig$"); + } + } + + @Override + public com.google.api.client.http.HttpResponse executeUsingHead() throws java.io.IOException { + return super.executeUsingHead(); + } + + @Override + public com.google.api.client.http.HttpRequest buildHttpRequestUsingHead() throws java.io.IOException { + return super.buildHttpRequestUsingHead(); + } + + @Override + public GetCompletionConfig set$Xgafv(java.lang.String $Xgafv) { + return (GetCompletionConfig) super.set$Xgafv($Xgafv); + } + + @Override + public GetCompletionConfig setAccessToken(java.lang.String accessToken) { + return (GetCompletionConfig) super.setAccessToken(accessToken); + } + + @Override + public GetCompletionConfig setAlt(java.lang.String alt) { + return (GetCompletionConfig) super.setAlt(alt); + } + + @Override + public GetCompletionConfig setCallback(java.lang.String callback) { + return (GetCompletionConfig) super.setCallback(callback); + } + + @Override + public GetCompletionConfig setFields(java.lang.String fields) { + return (GetCompletionConfig) super.setFields(fields); + } + + @Override + public GetCompletionConfig setKey(java.lang.String key) { + return (GetCompletionConfig) super.setKey(key); + } + + @Override + public GetCompletionConfig setOauthToken(java.lang.String oauthToken) { + return (GetCompletionConfig) super.setOauthToken(oauthToken); + } + + @Override + public GetCompletionConfig setPrettyPrint(java.lang.Boolean prettyPrint) { + return (GetCompletionConfig) super.setPrettyPrint(prettyPrint); + } + + @Override + public GetCompletionConfig setQuotaUser(java.lang.String quotaUser) { + return (GetCompletionConfig) super.setQuotaUser(quotaUser); + } + + @Override + public GetCompletionConfig setUploadType(java.lang.String uploadType) { + return (GetCompletionConfig) super.setUploadType(uploadType); + } + + @Override + public GetCompletionConfig setUploadProtocol(java.lang.String uploadProtocol) { + return (GetCompletionConfig) super.setUploadProtocol(uploadProtocol); + } + + /** + * Required. Full CompletionConfig resource name. Format: + * `projects/locations/dataStores/completionConfig` + * `projects/locations/collections/dataStores/completionConfig` + * `projects/locations/collections/engines/completionConfig` + */ + @com.google.api.client.util.Key + private java.lang.String name; + + /** Required. Full CompletionConfig resource name. Format: + `projects/locations/dataStores/completionConfig` + `projects/locations/collections/dataStores/completionConfig` + `projects/locations/collections/engines/completionConfig` + */ + public java.lang.String getName() { + return name; + } + + /** + * Required. Full CompletionConfig resource name. Format: + * `projects/locations/dataStores/completionConfig` + * `projects/locations/collections/dataStores/completionConfig` + * `projects/locations/collections/engines/completionConfig` + */ + public GetCompletionConfig setName(java.lang.String name) { + if (!getSuppressPatternChecks()) { + com.google.api.client.util.Preconditions.checkArgument(NAME_PATTERN.matcher(name).matches(), + "Parameter name must conform to the pattern " + + "^projects/[^/]+/locations/[^/]+/collections/[^/]+/dataStores/[^/]+/completionConfig$"); + } + this.name = name; + return this; + } + + @Override + public GetCompletionConfig set(String parameterName, Object value) { + return (GetCompletionConfig) super.set(parameterName, value); + } + } /** * Gets a DocumentProcessingConfig. * @@ -9829,6 +9988,195 @@ public TrainCustomModel set(String parameterName, Object value) { return (TrainCustomModel) super.set(parameterName, value); } } + /** + * Updates the CompletionConfigs. + * + * Create a request for the method "dataStores.updateCompletionConfig". + * + * This request holds the parameters needed by the discoveryengine server. After setting any + * optional parameters, call the {@link UpdateCompletionConfig#execute()} method to invoke the + * remote operation. + * + * @param name Required. Immutable. Fully qualified name `projects/locations/dataStores/completionConfig` + * `projects/locations/collections/dataStores/completionConfig` + * `projects/locations/collections/engines/completionConfig` + * @param content the {@link com.google.api.services.discoveryengine.v1alpha.model.GoogleCloudDiscoveryengineV1alphaCompletionConfig} + * @return the request + */ + public UpdateCompletionConfig updateCompletionConfig(java.lang.String name, com.google.api.services.discoveryengine.v1alpha.model.GoogleCloudDiscoveryengineV1alphaCompletionConfig content) throws java.io.IOException { + UpdateCompletionConfig result = new UpdateCompletionConfig(name, content); + initialize(result); + return result; + } + + public class UpdateCompletionConfig extends DiscoveryEngineRequest{@link UpdateCompletionConfig#initialize(com.google.api.client.googleapis + * .services.AbstractGoogleClientRequest)} must be called to initialize this instance immediately + * after invoking the constructor.
+ * + * @param name Required. Immutable. Fully qualified name `projects/locations/dataStores/completionConfig` + * `projects/locations/collections/dataStores/completionConfig` + * `projects/locations/collections/engines/completionConfig` + * @param content the {@link com.google.api.services.discoveryengine.v1alpha.model.GoogleCloudDiscoveryengineV1alphaCompletionConfig} + * @since 1.13 + */ + protected UpdateCompletionConfig(java.lang.String name, com.google.api.services.discoveryengine.v1alpha.model.GoogleCloudDiscoveryengineV1alphaCompletionConfig content) { + super(DiscoveryEngine.this, "PATCH", REST_PATH, content, com.google.api.services.discoveryengine.v1alpha.model.GoogleCloudDiscoveryengineV1alphaCompletionConfig.class); + this.name = com.google.api.client.util.Preconditions.checkNotNull(name, "Required parameter name must be specified."); + if (!getSuppressPatternChecks()) { + com.google.api.client.util.Preconditions.checkArgument(NAME_PATTERN.matcher(name).matches(), + "Parameter name must conform to the pattern " + + "^projects/[^/]+/locations/[^/]+/collections/[^/]+/dataStores/[^/]+/completionConfig$"); + } + } + + @Override + public UpdateCompletionConfig set$Xgafv(java.lang.String $Xgafv) { + return (UpdateCompletionConfig) super.set$Xgafv($Xgafv); + } + + @Override + public UpdateCompletionConfig setAccessToken(java.lang.String accessToken) { + return (UpdateCompletionConfig) super.setAccessToken(accessToken); + } + + @Override + public UpdateCompletionConfig setAlt(java.lang.String alt) { + return (UpdateCompletionConfig) super.setAlt(alt); + } + + @Override + public UpdateCompletionConfig setCallback(java.lang.String callback) { + return (UpdateCompletionConfig) super.setCallback(callback); + } + + @Override + public UpdateCompletionConfig setFields(java.lang.String fields) { + return (UpdateCompletionConfig) super.setFields(fields); + } + + @Override + public UpdateCompletionConfig setKey(java.lang.String key) { + return (UpdateCompletionConfig) super.setKey(key); + } + + @Override + public UpdateCompletionConfig setOauthToken(java.lang.String oauthToken) { + return (UpdateCompletionConfig) super.setOauthToken(oauthToken); + } + + @Override + public UpdateCompletionConfig setPrettyPrint(java.lang.Boolean prettyPrint) { + return (UpdateCompletionConfig) super.setPrettyPrint(prettyPrint); + } + + @Override + public UpdateCompletionConfig setQuotaUser(java.lang.String quotaUser) { + return (UpdateCompletionConfig) super.setQuotaUser(quotaUser); + } + + @Override + public UpdateCompletionConfig setUploadType(java.lang.String uploadType) { + return (UpdateCompletionConfig) super.setUploadType(uploadType); + } + + @Override + public UpdateCompletionConfig setUploadProtocol(java.lang.String uploadProtocol) { + return (UpdateCompletionConfig) super.setUploadProtocol(uploadProtocol); + } + + /** + * Required. Immutable. Fully qualified name + * `projects/locations/dataStores/completionConfig` + * `projects/locations/collections/dataStores/completionConfig` + * `projects/locations/collections/engines/completionConfig` + */ + @com.google.api.client.util.Key + private java.lang.String name; + + /** Required. Immutable. Fully qualified name `projects/locations/dataStores/completionConfig` + `projects/locations/collections/dataStores/completionConfig` + `projects/locations/collections/engines/completionConfig` + */ + public java.lang.String getName() { + return name; + } + + /** + * Required. Immutable. Fully qualified name + * `projects/locations/dataStores/completionConfig` + * `projects/locations/collections/dataStores/completionConfig` + * `projects/locations/collections/engines/completionConfig` + */ + public UpdateCompletionConfig setName(java.lang.String name) { + if (!getSuppressPatternChecks()) { + com.google.api.client.util.Preconditions.checkArgument(NAME_PATTERN.matcher(name).matches(), + "Parameter name must conform to the pattern " + + "^projects/[^/]+/locations/[^/]+/collections/[^/]+/dataStores/[^/]+/completionConfig$"); + } + this.name = name; + return this; + } + + /** + * Indicates which fields in the provided CompletionConfig to update. The following are + * the only supported fields: * CompletionConfig.matching_order * + * CompletionConfig.max_suggestions * CompletionConfig.min_prefix_length * + * CompletionConfig.query_model * CompletionConfig.enable_mode * + * CompletionConfig.query_frequency_threshold * + * CompletionConfig.num_unique_users_threshold * + * CompletionConfig.should_serve_content_suggestions * + * CompletionConfig.filter_pii_suggestions_using_dlp If not set, all supported fields + * are updated. + */ + @com.google.api.client.util.Key + private String updateMask; + + /** Indicates which fields in the provided CompletionConfig to update. The following are the only + supported fields: * CompletionConfig.matching_order * CompletionConfig.max_suggestions * + CompletionConfig.min_prefix_length * CompletionConfig.query_model * CompletionConfig.enable_mode * + CompletionConfig.query_frequency_threshold * CompletionConfig.num_unique_users_threshold * + CompletionConfig.should_serve_content_suggestions * + CompletionConfig.filter_pii_suggestions_using_dlp If not set, all supported fields are updated. + */ + public String getUpdateMask() { + return updateMask; + } + + /** + * Indicates which fields in the provided CompletionConfig to update. The following are + * the only supported fields: * CompletionConfig.matching_order * + * CompletionConfig.max_suggestions * CompletionConfig.min_prefix_length * + * CompletionConfig.query_model * CompletionConfig.enable_mode * + * CompletionConfig.query_frequency_threshold * + * CompletionConfig.num_unique_users_threshold * + * CompletionConfig.should_serve_content_suggestions * + * CompletionConfig.filter_pii_suggestions_using_dlp If not set, all supported fields + * are updated. + */ + public UpdateCompletionConfig setUpdateMask(String updateMask) { + this.updateMask = updateMask; + return this; + } + + @Override + public UpdateCompletionConfig set(String parameterName, Object value) { + return (UpdateCompletionConfig) super.set(parameterName, value); + } + } /** * Updates the DocumentProcessingConfig. DocumentProcessingConfig is a singleon resource of * DataStore. It's empty when DataStore is created. The first call to this method will set up @@ -25519,59 +25867,57 @@ public Get set(String parameterName, Object value) { } } /** - * Gets the IAM access control policy for an Engine. A `NOT_FOUND` error is returned if the resource - * does not exist. An empty policy is returned if the resource exists but does not have a policy set - * on it. + * Gets a CompletionConfig * - * Create a request for the method "engines.getIamPolicy". + * Create a request for the method "engines.getCompletionConfig". * * This request holds the parameters needed by the discoveryengine server. After setting any - * optional parameters, call the {@link GetIamPolicy#execute()} method to invoke the remote + * optional parameters, call the {@link GetCompletionConfig#execute()} method to invoke the remote * operation. * - * @param resource REQUIRED: The resource for which the policy is being requested. See [Resource - * names](https://cloud.google.com/apis/design/resource_names) for the appropriate value for - * this field. + * @param name Required. Full CompletionConfig resource name. Format: + * `projects/locations/dataStores/completionConfig` + * `projects/locations/collections/dataStores/completionConfig` + * `projects/locations/collections/engines/completionConfig` * @return the request */ - public GetIamPolicy getIamPolicy(java.lang.String resource) throws java.io.IOException { - GetIamPolicy result = new GetIamPolicy(resource); + public GetCompletionConfig getCompletionConfig(java.lang.String name) throws java.io.IOException { + GetCompletionConfig result = new GetCompletionConfig(name); initialize(result); return result; } - public class GetIamPolicy extends DiscoveryEngineRequest{@link - * GetIamPolicy#initialize(com.google.api.client.googleapis.services.AbstractGoogleClientRequest)} - * must be called to initialize this instance immediately after invoking the constructor.
+ * optional parameters, call the {@link GetCompletionConfig#execute()} method to invoke the remote + * operation.{@link GetCompletionConfig#initialize(com.google.api.client.googleapis.services. + * AbstractGoogleClientRequest)} must be called to initialize this instance immediately after + * invoking the constructor.
* - * @param resource REQUIRED: The resource for which the policy is being requested. See [Resource - * names](https://cloud.google.com/apis/design/resource_names) for the appropriate value for - * this field. + * @param name Required. Full CompletionConfig resource name. Format: + * `projects/locations/dataStores/completionConfig` + * `projects/locations/collections/dataStores/completionConfig` + * `projects/locations/collections/engines/completionConfig` * @since 1.13 */ - protected GetIamPolicy(java.lang.String resource) { - super(DiscoveryEngine.this, "GET", REST_PATH, null, com.google.api.services.discoveryengine.v1alpha.model.GoogleIamV1Policy.class); - this.resource = com.google.api.client.util.Preconditions.checkNotNull(resource, "Required parameter resource must be specified."); + protected GetCompletionConfig(java.lang.String name) { + super(DiscoveryEngine.this, "GET", REST_PATH, null, com.google.api.services.discoveryengine.v1alpha.model.GoogleCloudDiscoveryengineV1alphaCompletionConfig.class); + this.name = com.google.api.client.util.Preconditions.checkNotNull(name, "Required parameter name must be specified."); if (!getSuppressPatternChecks()) { - com.google.api.client.util.Preconditions.checkArgument(RESOURCE_PATTERN.matcher(resource).matches(), - "Parameter resource must conform to the pattern " + - "^projects/[^/]+/locations/[^/]+/collections/[^/]+/engines/[^/]+$"); + com.google.api.client.util.Preconditions.checkArgument(NAME_PATTERN.matcher(name).matches(), + "Parameter name must conform to the pattern " + + "^projects/[^/]+/locations/[^/]+/collections/[^/]+/engines/[^/]+/completionConfig$"); } } @@ -25586,42 +25932,203 @@ public com.google.api.client.http.HttpRequest buildHttpRequestUsingHead() throws } @Override - public GetIamPolicy set$Xgafv(java.lang.String $Xgafv) { - return (GetIamPolicy) super.set$Xgafv($Xgafv); + public GetCompletionConfig set$Xgafv(java.lang.String $Xgafv) { + return (GetCompletionConfig) super.set$Xgafv($Xgafv); } @Override - public GetIamPolicy setAccessToken(java.lang.String accessToken) { - return (GetIamPolicy) super.setAccessToken(accessToken); + public GetCompletionConfig setAccessToken(java.lang.String accessToken) { + return (GetCompletionConfig) super.setAccessToken(accessToken); } @Override - public GetIamPolicy setAlt(java.lang.String alt) { - return (GetIamPolicy) super.setAlt(alt); + public GetCompletionConfig setAlt(java.lang.String alt) { + return (GetCompletionConfig) super.setAlt(alt); } @Override - public GetIamPolicy setCallback(java.lang.String callback) { - return (GetIamPolicy) super.setCallback(callback); + public GetCompletionConfig setCallback(java.lang.String callback) { + return (GetCompletionConfig) super.setCallback(callback); } @Override - public GetIamPolicy setFields(java.lang.String fields) { - return (GetIamPolicy) super.setFields(fields); + public GetCompletionConfig setFields(java.lang.String fields) { + return (GetCompletionConfig) super.setFields(fields); } @Override - public GetIamPolicy setKey(java.lang.String key) { - return (GetIamPolicy) super.setKey(key); + public GetCompletionConfig setKey(java.lang.String key) { + return (GetCompletionConfig) super.setKey(key); } @Override - public GetIamPolicy setOauthToken(java.lang.String oauthToken) { - return (GetIamPolicy) super.setOauthToken(oauthToken); + public GetCompletionConfig setOauthToken(java.lang.String oauthToken) { + return (GetCompletionConfig) super.setOauthToken(oauthToken); } @Override - public GetIamPolicy setPrettyPrint(java.lang.Boolean prettyPrint) { + public GetCompletionConfig setPrettyPrint(java.lang.Boolean prettyPrint) { + return (GetCompletionConfig) super.setPrettyPrint(prettyPrint); + } + + @Override + public GetCompletionConfig setQuotaUser(java.lang.String quotaUser) { + return (GetCompletionConfig) super.setQuotaUser(quotaUser); + } + + @Override + public GetCompletionConfig setUploadType(java.lang.String uploadType) { + return (GetCompletionConfig) super.setUploadType(uploadType); + } + + @Override + public GetCompletionConfig setUploadProtocol(java.lang.String uploadProtocol) { + return (GetCompletionConfig) super.setUploadProtocol(uploadProtocol); + } + + /** + * Required. Full CompletionConfig resource name. Format: + * `projects/locations/dataStores/completionConfig` + * `projects/locations/collections/dataStores/completionConfig` + * `projects/locations/collections/engines/completionConfig` + */ + @com.google.api.client.util.Key + private java.lang.String name; + + /** Required. Full CompletionConfig resource name. Format: + `projects/locations/dataStores/completionConfig` + `projects/locations/collections/dataStores/completionConfig` + `projects/locations/collections/engines/completionConfig` + */ + public java.lang.String getName() { + return name; + } + + /** + * Required. Full CompletionConfig resource name. Format: + * `projects/locations/dataStores/completionConfig` + * `projects/locations/collections/dataStores/completionConfig` + * `projects/locations/collections/engines/completionConfig` + */ + public GetCompletionConfig setName(java.lang.String name) { + if (!getSuppressPatternChecks()) { + com.google.api.client.util.Preconditions.checkArgument(NAME_PATTERN.matcher(name).matches(), + "Parameter name must conform to the pattern " + + "^projects/[^/]+/locations/[^/]+/collections/[^/]+/engines/[^/]+/completionConfig$"); + } + this.name = name; + return this; + } + + @Override + public GetCompletionConfig set(String parameterName, Object value) { + return (GetCompletionConfig) super.set(parameterName, value); + } + } + /** + * Gets the IAM access control policy for an Engine. A `NOT_FOUND` error is returned if the resource + * does not exist. An empty policy is returned if the resource exists but does not have a policy set + * on it. + * + * Create a request for the method "engines.getIamPolicy". + * + * This request holds the parameters needed by the discoveryengine server. After setting any + * optional parameters, call the {@link GetIamPolicy#execute()} method to invoke the remote + * operation. + * + * @param resource REQUIRED: The resource for which the policy is being requested. See [Resource + * names](https://cloud.google.com/apis/design/resource_names) for the appropriate value for + * this field. + * @return the request + */ + public GetIamPolicy getIamPolicy(java.lang.String resource) throws java.io.IOException { + GetIamPolicy result = new GetIamPolicy(resource); + initialize(result); + return result; + } + + public class GetIamPolicy extends DiscoveryEngineRequest{@link + * GetIamPolicy#initialize(com.google.api.client.googleapis.services.AbstractGoogleClientRequest)} + * must be called to initialize this instance immediately after invoking the constructor.
+ * + * @param resource REQUIRED: The resource for which the policy is being requested. See [Resource + * names](https://cloud.google.com/apis/design/resource_names) for the appropriate value for + * this field. + * @since 1.13 + */ + protected GetIamPolicy(java.lang.String resource) { + super(DiscoveryEngine.this, "GET", REST_PATH, null, com.google.api.services.discoveryengine.v1alpha.model.GoogleIamV1Policy.class); + this.resource = com.google.api.client.util.Preconditions.checkNotNull(resource, "Required parameter resource must be specified."); + if (!getSuppressPatternChecks()) { + com.google.api.client.util.Preconditions.checkArgument(RESOURCE_PATTERN.matcher(resource).matches(), + "Parameter resource must conform to the pattern " + + "^projects/[^/]+/locations/[^/]+/collections/[^/]+/engines/[^/]+$"); + } + } + + @Override + public com.google.api.client.http.HttpResponse executeUsingHead() throws java.io.IOException { + return super.executeUsingHead(); + } + + @Override + public com.google.api.client.http.HttpRequest buildHttpRequestUsingHead() throws java.io.IOException { + return super.buildHttpRequestUsingHead(); + } + + @Override + public GetIamPolicy set$Xgafv(java.lang.String $Xgafv) { + return (GetIamPolicy) super.set$Xgafv($Xgafv); + } + + @Override + public GetIamPolicy setAccessToken(java.lang.String accessToken) { + return (GetIamPolicy) super.setAccessToken(accessToken); + } + + @Override + public GetIamPolicy setAlt(java.lang.String alt) { + return (GetIamPolicy) super.setAlt(alt); + } + + @Override + public GetIamPolicy setCallback(java.lang.String callback) { + return (GetIamPolicy) super.setCallback(callback); + } + + @Override + public GetIamPolicy setFields(java.lang.String fields) { + return (GetIamPolicy) super.setFields(fields); + } + + @Override + public GetIamPolicy setKey(java.lang.String key) { + return (GetIamPolicy) super.setKey(key); + } + + @Override + public GetIamPolicy setOauthToken(java.lang.String oauthToken) { + return (GetIamPolicy) super.setOauthToken(oauthToken); + } + + @Override + public GetIamPolicy setPrettyPrint(java.lang.Boolean prettyPrint) { return (GetIamPolicy) super.setPrettyPrint(prettyPrint); } @@ -26826,6 +27333,195 @@ public Tune set(String parameterName, Object value) { return (Tune) super.set(parameterName, value); } } + /** + * Updates the CompletionConfigs. + * + * Create a request for the method "engines.updateCompletionConfig". + * + * This request holds the parameters needed by the discoveryengine server. After setting any + * optional parameters, call the {@link UpdateCompletionConfig#execute()} method to invoke the + * remote operation. + * + * @param name Required. Immutable. Fully qualified name `projects/locations/dataStores/completionConfig` + * `projects/locations/collections/dataStores/completionConfig` + * `projects/locations/collections/engines/completionConfig` + * @param content the {@link com.google.api.services.discoveryengine.v1alpha.model.GoogleCloudDiscoveryengineV1alphaCompletionConfig} + * @return the request + */ + public UpdateCompletionConfig updateCompletionConfig(java.lang.String name, com.google.api.services.discoveryengine.v1alpha.model.GoogleCloudDiscoveryengineV1alphaCompletionConfig content) throws java.io.IOException { + UpdateCompletionConfig result = new UpdateCompletionConfig(name, content); + initialize(result); + return result; + } + + public class UpdateCompletionConfig extends DiscoveryEngineRequest{@link UpdateCompletionConfig#initialize(com.google.api.client.googleapis + * .services.AbstractGoogleClientRequest)} must be called to initialize this instance immediately + * after invoking the constructor.
+ * + * @param name Required. Immutable. Fully qualified name `projects/locations/dataStores/completionConfig` + * `projects/locations/collections/dataStores/completionConfig` + * `projects/locations/collections/engines/completionConfig` + * @param content the {@link com.google.api.services.discoveryengine.v1alpha.model.GoogleCloudDiscoveryengineV1alphaCompletionConfig} + * @since 1.13 + */ + protected UpdateCompletionConfig(java.lang.String name, com.google.api.services.discoveryengine.v1alpha.model.GoogleCloudDiscoveryengineV1alphaCompletionConfig content) { + super(DiscoveryEngine.this, "PATCH", REST_PATH, content, com.google.api.services.discoveryengine.v1alpha.model.GoogleCloudDiscoveryengineV1alphaCompletionConfig.class); + this.name = com.google.api.client.util.Preconditions.checkNotNull(name, "Required parameter name must be specified."); + if (!getSuppressPatternChecks()) { + com.google.api.client.util.Preconditions.checkArgument(NAME_PATTERN.matcher(name).matches(), + "Parameter name must conform to the pattern " + + "^projects/[^/]+/locations/[^/]+/collections/[^/]+/engines/[^/]+/completionConfig$"); + } + } + + @Override + public UpdateCompletionConfig set$Xgafv(java.lang.String $Xgafv) { + return (UpdateCompletionConfig) super.set$Xgafv($Xgafv); + } + + @Override + public UpdateCompletionConfig setAccessToken(java.lang.String accessToken) { + return (UpdateCompletionConfig) super.setAccessToken(accessToken); + } + + @Override + public UpdateCompletionConfig setAlt(java.lang.String alt) { + return (UpdateCompletionConfig) super.setAlt(alt); + } + + @Override + public UpdateCompletionConfig setCallback(java.lang.String callback) { + return (UpdateCompletionConfig) super.setCallback(callback); + } + + @Override + public UpdateCompletionConfig setFields(java.lang.String fields) { + return (UpdateCompletionConfig) super.setFields(fields); + } + + @Override + public UpdateCompletionConfig setKey(java.lang.String key) { + return (UpdateCompletionConfig) super.setKey(key); + } + + @Override + public UpdateCompletionConfig setOauthToken(java.lang.String oauthToken) { + return (UpdateCompletionConfig) super.setOauthToken(oauthToken); + } + + @Override + public UpdateCompletionConfig setPrettyPrint(java.lang.Boolean prettyPrint) { + return (UpdateCompletionConfig) super.setPrettyPrint(prettyPrint); + } + + @Override + public UpdateCompletionConfig setQuotaUser(java.lang.String quotaUser) { + return (UpdateCompletionConfig) super.setQuotaUser(quotaUser); + } + + @Override + public UpdateCompletionConfig setUploadType(java.lang.String uploadType) { + return (UpdateCompletionConfig) super.setUploadType(uploadType); + } + + @Override + public UpdateCompletionConfig setUploadProtocol(java.lang.String uploadProtocol) { + return (UpdateCompletionConfig) super.setUploadProtocol(uploadProtocol); + } + + /** + * Required. Immutable. Fully qualified name + * `projects/locations/dataStores/completionConfig` + * `projects/locations/collections/dataStores/completionConfig` + * `projects/locations/collections/engines/completionConfig` + */ + @com.google.api.client.util.Key + private java.lang.String name; + + /** Required. Immutable. Fully qualified name `projects/locations/dataStores/completionConfig` + `projects/locations/collections/dataStores/completionConfig` + `projects/locations/collections/engines/completionConfig` + */ + public java.lang.String getName() { + return name; + } + + /** + * Required. Immutable. Fully qualified name + * `projects/locations/dataStores/completionConfig` + * `projects/locations/collections/dataStores/completionConfig` + * `projects/locations/collections/engines/completionConfig` + */ + public UpdateCompletionConfig setName(java.lang.String name) { + if (!getSuppressPatternChecks()) { + com.google.api.client.util.Preconditions.checkArgument(NAME_PATTERN.matcher(name).matches(), + "Parameter name must conform to the pattern " + + "^projects/[^/]+/locations/[^/]+/collections/[^/]+/engines/[^/]+/completionConfig$"); + } + this.name = name; + return this; + } + + /** + * Indicates which fields in the provided CompletionConfig to update. The following are + * the only supported fields: * CompletionConfig.matching_order * + * CompletionConfig.max_suggestions * CompletionConfig.min_prefix_length * + * CompletionConfig.query_model * CompletionConfig.enable_mode * + * CompletionConfig.query_frequency_threshold * + * CompletionConfig.num_unique_users_threshold * + * CompletionConfig.should_serve_content_suggestions * + * CompletionConfig.filter_pii_suggestions_using_dlp If not set, all supported fields + * are updated. + */ + @com.google.api.client.util.Key + private String updateMask; + + /** Indicates which fields in the provided CompletionConfig to update. The following are the only + supported fields: * CompletionConfig.matching_order * CompletionConfig.max_suggestions * + CompletionConfig.min_prefix_length * CompletionConfig.query_model * CompletionConfig.enable_mode * + CompletionConfig.query_frequency_threshold * CompletionConfig.num_unique_users_threshold * + CompletionConfig.should_serve_content_suggestions * + CompletionConfig.filter_pii_suggestions_using_dlp If not set, all supported fields are updated. + */ + public String getUpdateMask() { + return updateMask; + } + + /** + * Indicates which fields in the provided CompletionConfig to update. The following are + * the only supported fields: * CompletionConfig.matching_order * + * CompletionConfig.max_suggestions * CompletionConfig.min_prefix_length * + * CompletionConfig.query_model * CompletionConfig.enable_mode * + * CompletionConfig.query_frequency_threshold * + * CompletionConfig.num_unique_users_threshold * + * CompletionConfig.should_serve_content_suggestions * + * CompletionConfig.filter_pii_suggestions_using_dlp If not set, all supported fields + * are updated. + */ + public UpdateCompletionConfig setUpdateMask(String updateMask) { + this.updateMask = updateMask; + return this; + } + + @Override + public UpdateCompletionConfig set(String parameterName, Object value) { + return (UpdateCompletionConfig) super.set(parameterName, value); + } + } /** * An accessor for creating requests from the Analytics collection. @@ -38444,6 +39140,165 @@ public Get set(String parameterName, Object value) { return (Get) super.set(parameterName, value); } } + /** + * Gets a CompletionConfig + * + * Create a request for the method "dataStores.getCompletionConfig". + * + * This request holds the parameters needed by the discoveryengine server. After setting any + * optional parameters, call the {@link GetCompletionConfig#execute()} method to invoke the remote + * operation. + * + * @param name Required. Full CompletionConfig resource name. Format: + * `projects/locations/dataStores/completionConfig` + * `projects/locations/collections/dataStores/completionConfig` + * `projects/locations/collections/engines/completionConfig` + * @return the request + */ + public GetCompletionConfig getCompletionConfig(java.lang.String name) throws java.io.IOException { + GetCompletionConfig result = new GetCompletionConfig(name); + initialize(result); + return result; + } + + public class GetCompletionConfig extends DiscoveryEngineRequest{@link GetCompletionConfig#initialize(com.google.api.client.googleapis.services. + * AbstractGoogleClientRequest)} must be called to initialize this instance immediately after + * invoking the constructor.
+ * + * @param name Required. Full CompletionConfig resource name. Format: + * `projects/locations/dataStores/completionConfig` + * `projects/locations/collections/dataStores/completionConfig` + * `projects/locations/collections/engines/completionConfig` + * @since 1.13 + */ + protected GetCompletionConfig(java.lang.String name) { + super(DiscoveryEngine.this, "GET", REST_PATH, null, com.google.api.services.discoveryengine.v1alpha.model.GoogleCloudDiscoveryengineV1alphaCompletionConfig.class); + this.name = com.google.api.client.util.Preconditions.checkNotNull(name, "Required parameter name must be specified."); + if (!getSuppressPatternChecks()) { + com.google.api.client.util.Preconditions.checkArgument(NAME_PATTERN.matcher(name).matches(), + "Parameter name must conform to the pattern " + + "^projects/[^/]+/locations/[^/]+/dataStores/[^/]+/completionConfig$"); + } + } + + @Override + public com.google.api.client.http.HttpResponse executeUsingHead() throws java.io.IOException { + return super.executeUsingHead(); + } + + @Override + public com.google.api.client.http.HttpRequest buildHttpRequestUsingHead() throws java.io.IOException { + return super.buildHttpRequestUsingHead(); + } + + @Override + public GetCompletionConfig set$Xgafv(java.lang.String $Xgafv) { + return (GetCompletionConfig) super.set$Xgafv($Xgafv); + } + + @Override + public GetCompletionConfig setAccessToken(java.lang.String accessToken) { + return (GetCompletionConfig) super.setAccessToken(accessToken); + } + + @Override + public GetCompletionConfig setAlt(java.lang.String alt) { + return (GetCompletionConfig) super.setAlt(alt); + } + + @Override + public GetCompletionConfig setCallback(java.lang.String callback) { + return (GetCompletionConfig) super.setCallback(callback); + } + + @Override + public GetCompletionConfig setFields(java.lang.String fields) { + return (GetCompletionConfig) super.setFields(fields); + } + + @Override + public GetCompletionConfig setKey(java.lang.String key) { + return (GetCompletionConfig) super.setKey(key); + } + + @Override + public GetCompletionConfig setOauthToken(java.lang.String oauthToken) { + return (GetCompletionConfig) super.setOauthToken(oauthToken); + } + + @Override + public GetCompletionConfig setPrettyPrint(java.lang.Boolean prettyPrint) { + return (GetCompletionConfig) super.setPrettyPrint(prettyPrint); + } + + @Override + public GetCompletionConfig setQuotaUser(java.lang.String quotaUser) { + return (GetCompletionConfig) super.setQuotaUser(quotaUser); + } + + @Override + public GetCompletionConfig setUploadType(java.lang.String uploadType) { + return (GetCompletionConfig) super.setUploadType(uploadType); + } + + @Override + public GetCompletionConfig setUploadProtocol(java.lang.String uploadProtocol) { + return (GetCompletionConfig) super.setUploadProtocol(uploadProtocol); + } + + /** + * Required. Full CompletionConfig resource name. Format: + * `projects/locations/dataStores/completionConfig` + * `projects/locations/collections/dataStores/completionConfig` + * `projects/locations/collections/engines/completionConfig` + */ + @com.google.api.client.util.Key + private java.lang.String name; + + /** Required. Full CompletionConfig resource name. Format: + `projects/locations/dataStores/completionConfig` + `projects/locations/collections/dataStores/completionConfig` + `projects/locations/collections/engines/completionConfig` + */ + public java.lang.String getName() { + return name; + } + + /** + * Required. Full CompletionConfig resource name. Format: + * `projects/locations/dataStores/completionConfig` + * `projects/locations/collections/dataStores/completionConfig` + * `projects/locations/collections/engines/completionConfig` + */ + public GetCompletionConfig setName(java.lang.String name) { + if (!getSuppressPatternChecks()) { + com.google.api.client.util.Preconditions.checkArgument(NAME_PATTERN.matcher(name).matches(), + "Parameter name must conform to the pattern " + + "^projects/[^/]+/locations/[^/]+/dataStores/[^/]+/completionConfig$"); + } + this.name = name; + return this; + } + + @Override + public GetCompletionConfig set(String parameterName, Object value) { + return (GetCompletionConfig) super.set(parameterName, value); + } + } /** * Gets a DocumentProcessingConfig. * @@ -39498,6 +40353,195 @@ public ReplacePatientFilter set(String parameterName, Object value) { return (ReplacePatientFilter) super.set(parameterName, value); } } + /** + * Updates the CompletionConfigs. + * + * Create a request for the method "dataStores.updateCompletionConfig". + * + * This request holds the parameters needed by the discoveryengine server. After setting any + * optional parameters, call the {@link UpdateCompletionConfig#execute()} method to invoke the + * remote operation. + * + * @param name Required. Immutable. Fully qualified name `projects/locations/dataStores/completionConfig` + * `projects/locations/collections/dataStores/completionConfig` + * `projects/locations/collections/engines/completionConfig` + * @param content the {@link com.google.api.services.discoveryengine.v1alpha.model.GoogleCloudDiscoveryengineV1alphaCompletionConfig} + * @return the request + */ + public UpdateCompletionConfig updateCompletionConfig(java.lang.String name, com.google.api.services.discoveryengine.v1alpha.model.GoogleCloudDiscoveryengineV1alphaCompletionConfig content) throws java.io.IOException { + UpdateCompletionConfig result = new UpdateCompletionConfig(name, content); + initialize(result); + return result; + } + + public class UpdateCompletionConfig extends DiscoveryEngineRequest{@link UpdateCompletionConfig#initialize(com.google.api.client.googleapis + * .services.AbstractGoogleClientRequest)} must be called to initialize this instance immediately + * after invoking the constructor.
+ * + * @param name Required. Immutable. Fully qualified name `projects/locations/dataStores/completionConfig` + * `projects/locations/collections/dataStores/completionConfig` + * `projects/locations/collections/engines/completionConfig` + * @param content the {@link com.google.api.services.discoveryengine.v1alpha.model.GoogleCloudDiscoveryengineV1alphaCompletionConfig} + * @since 1.13 + */ + protected UpdateCompletionConfig(java.lang.String name, com.google.api.services.discoveryengine.v1alpha.model.GoogleCloudDiscoveryengineV1alphaCompletionConfig content) { + super(DiscoveryEngine.this, "PATCH", REST_PATH, content, com.google.api.services.discoveryengine.v1alpha.model.GoogleCloudDiscoveryengineV1alphaCompletionConfig.class); + this.name = com.google.api.client.util.Preconditions.checkNotNull(name, "Required parameter name must be specified."); + if (!getSuppressPatternChecks()) { + com.google.api.client.util.Preconditions.checkArgument(NAME_PATTERN.matcher(name).matches(), + "Parameter name must conform to the pattern " + + "^projects/[^/]+/locations/[^/]+/dataStores/[^/]+/completionConfig$"); + } + } + + @Override + public UpdateCompletionConfig set$Xgafv(java.lang.String $Xgafv) { + return (UpdateCompletionConfig) super.set$Xgafv($Xgafv); + } + + @Override + public UpdateCompletionConfig setAccessToken(java.lang.String accessToken) { + return (UpdateCompletionConfig) super.setAccessToken(accessToken); + } + + @Override + public UpdateCompletionConfig setAlt(java.lang.String alt) { + return (UpdateCompletionConfig) super.setAlt(alt); + } + + @Override + public UpdateCompletionConfig setCallback(java.lang.String callback) { + return (UpdateCompletionConfig) super.setCallback(callback); + } + + @Override + public UpdateCompletionConfig setFields(java.lang.String fields) { + return (UpdateCompletionConfig) super.setFields(fields); + } + + @Override + public UpdateCompletionConfig setKey(java.lang.String key) { + return (UpdateCompletionConfig) super.setKey(key); + } + + @Override + public UpdateCompletionConfig setOauthToken(java.lang.String oauthToken) { + return (UpdateCompletionConfig) super.setOauthToken(oauthToken); + } + + @Override + public UpdateCompletionConfig setPrettyPrint(java.lang.Boolean prettyPrint) { + return (UpdateCompletionConfig) super.setPrettyPrint(prettyPrint); + } + + @Override + public UpdateCompletionConfig setQuotaUser(java.lang.String quotaUser) { + return (UpdateCompletionConfig) super.setQuotaUser(quotaUser); + } + + @Override + public UpdateCompletionConfig setUploadType(java.lang.String uploadType) { + return (UpdateCompletionConfig) super.setUploadType(uploadType); + } + + @Override + public UpdateCompletionConfig setUploadProtocol(java.lang.String uploadProtocol) { + return (UpdateCompletionConfig) super.setUploadProtocol(uploadProtocol); + } + + /** + * Required. Immutable. Fully qualified name + * `projects/locations/dataStores/completionConfig` + * `projects/locations/collections/dataStores/completionConfig` + * `projects/locations/collections/engines/completionConfig` + */ + @com.google.api.client.util.Key + private java.lang.String name; + + /** Required. Immutable. Fully qualified name `projects/locations/dataStores/completionConfig` + `projects/locations/collections/dataStores/completionConfig` + `projects/locations/collections/engines/completionConfig` + */ + public java.lang.String getName() { + return name; + } + + /** + * Required. Immutable. Fully qualified name + * `projects/locations/dataStores/completionConfig` + * `projects/locations/collections/dataStores/completionConfig` + * `projects/locations/collections/engines/completionConfig` + */ + public UpdateCompletionConfig setName(java.lang.String name) { + if (!getSuppressPatternChecks()) { + com.google.api.client.util.Preconditions.checkArgument(NAME_PATTERN.matcher(name).matches(), + "Parameter name must conform to the pattern " + + "^projects/[^/]+/locations/[^/]+/dataStores/[^/]+/completionConfig$"); + } + this.name = name; + return this; + } + + /** + * Indicates which fields in the provided CompletionConfig to update. The following are + * the only supported fields: * CompletionConfig.matching_order * + * CompletionConfig.max_suggestions * CompletionConfig.min_prefix_length * + * CompletionConfig.query_model * CompletionConfig.enable_mode * + * CompletionConfig.query_frequency_threshold * + * CompletionConfig.num_unique_users_threshold * + * CompletionConfig.should_serve_content_suggestions * + * CompletionConfig.filter_pii_suggestions_using_dlp If not set, all supported fields are + * updated. + */ + @com.google.api.client.util.Key + private String updateMask; + + /** Indicates which fields in the provided CompletionConfig to update. The following are the only + supported fields: * CompletionConfig.matching_order * CompletionConfig.max_suggestions * + CompletionConfig.min_prefix_length * CompletionConfig.query_model * CompletionConfig.enable_mode * + CompletionConfig.query_frequency_threshold * CompletionConfig.num_unique_users_threshold * + CompletionConfig.should_serve_content_suggestions * + CompletionConfig.filter_pii_suggestions_using_dlp If not set, all supported fields are updated. + */ + public String getUpdateMask() { + return updateMask; + } + + /** + * Indicates which fields in the provided CompletionConfig to update. The following are + * the only supported fields: * CompletionConfig.matching_order * + * CompletionConfig.max_suggestions * CompletionConfig.min_prefix_length * + * CompletionConfig.query_model * CompletionConfig.enable_mode * + * CompletionConfig.query_frequency_threshold * + * CompletionConfig.num_unique_users_threshold * + * CompletionConfig.should_serve_content_suggestions * + * CompletionConfig.filter_pii_suggestions_using_dlp If not set, all supported fields are + * updated. + */ + public UpdateCompletionConfig setUpdateMask(String updateMask) { + this.updateMask = updateMask; + return this; + } + + @Override + public UpdateCompletionConfig set(String parameterName, Object value) { + return (UpdateCompletionConfig) super.set(parameterName, value); + } + } /** * Updates the DocumentProcessingConfig. DocumentProcessingConfig is a singleon resource of * DataStore. It's empty when DataStore is created. The first call to this method will set up diff --git a/clients/google-api-services-discoveryengine/v1alpha/2.0.0/com/google/api/services/discoveryengine/v1alpha/model/GoogleCloudDiscoveryengineV1Engine.java b/clients/google-api-services-discoveryengine/v1alpha/2.0.0/com/google/api/services/discoveryengine/v1alpha/model/GoogleCloudDiscoveryengineV1Engine.java index 6a1988715a2..0e03ed19ebb 100644 --- a/clients/google-api-services-discoveryengine/v1alpha/2.0.0/com/google/api/services/discoveryengine/v1alpha/model/GoogleCloudDiscoveryengineV1Engine.java +++ b/clients/google-api-services-discoveryengine/v1alpha/2.0.0/com/google/api/services/discoveryengine/v1alpha/model/GoogleCloudDiscoveryengineV1Engine.java @@ -132,7 +132,7 @@ public final class GoogleCloudDiscoveryengineV1Engine extends com.google.api.cli * * `disable-onedrive-upload` * `disable-talk-to-content` * `disable-google-drive-upload` * * `disable-welcome-emails` * `disable-canvas` * `disable-canvas-workspace` * `disable-skills` * * `enable-end-user-sharing-with-groups` * `single-agent-orchestration` * `multi-agent- - * orchestration` + * orchestration` * `cross-product-intelligence` * The value may be {@code null}. */ @com.google.api.client.util.Key @@ -460,7 +460,7 @@ public GoogleCloudDiscoveryengineV1Engine setDisplayName(java.lang.String displa * * `disable-onedrive-upload` * `disable-talk-to-content` * `disable-google-drive-upload` * * `disable-welcome-emails` * `disable-canvas` * `disable-canvas-workspace` * `disable-skills` * * `enable-end-user-sharing-with-groups` * `single-agent-orchestration` * `multi-agent- - * orchestration` + * orchestration` * `cross-product-intelligence` * @return value or {@code null} for none */ public java.util.MapThis is the Java data model class that specifies how to parse/serialize into the JSON that is + * transmitted over HTTP when working with the Discovery Engine 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 GoogleCloudDiscoveryengineV1alphaCompletionConfig extends com.google.api.client.json.GenericJson { + + /** + * The enable mode of autocomplete generation pipelines. If this field is unset, the server + * behavior defaults to CompletionConfig.EnableMode.AUTOMATIC. Applies to DataStore only. Ignored + * for Engine. + * The value may be {@code null}. + */ + @com.google.api.client.util.Key + private java.lang.String enableMode; + + /** + * If true, with best effort, try to detect and remove the suggestions containing certain types of + * PII information. This detection is performated by + * [DLP](https://cloud.google.com/security/products/dlp) under the hood. + * The value may be {@code null}. + */ + @com.google.api.client.util.Key + private java.lang.Boolean filterPiiSuggestionsUsingDlp; + + /** + * The matching order for autocomplete suggestions, e.g., a query consisting of `sh` with `out-of- + * order` specified would suggest `women's shoes`, whereas a query of `red s` with `exact-prefix` + * specified would suggest `red shoes`. Currently supported values: * `out-of-order` * `exact- + * prefix` Default value: `exact-prefix`. + * The value may be {@code null}. + */ + @com.google.api.client.util.Key + private java.lang.String matchingOrder; + + /** + * The maximum number of autocomplete suggestions returned per term. max_suggestions must lie + * within the range of [1, 20]. If not set or set to 0, it will be set to the default of 20 + * suggestions. + * The value may be {@code null}. + */ + @com.google.api.client.util.Key + private java.lang.Integer maxSuggestions; + + /** + * The minimum number of characters needed to be typed in order to get suggestions. + * min_prefix_length must lie within the range of [1, 20]. If not set or set to 0, it will be set + * to the default of 1 character. + * The value may be {@code null}. + */ + @com.google.api.client.util.Key + private java.lang.Integer minPrefixLength; + + /** + * Required. Immutable. Fully qualified name `projects/locations/dataStores/completionConfig` + * `projects/locations/collections/dataStores/completionConfig` + * `projects/locations/collections/engines/completionConfig` + * The value may be {@code null}. + */ + @com.google.api.client.util.Key + private java.lang.String name; + + /** + * This field is only meaningful for suggestions generated from user events or search history, + * which may have user ids attached. If the number of unique users that have searched a query is + * less than this threshold, the query will not be generated as a suggestion. This is field can be + * helpful for preventing PII queries becoming suggestions, as those queries are usually uniquely + * searched. If not set, the default value is 3 used in the generation pipeline. + * The value may be {@code null}. + */ + @com.google.api.client.util.Key + private java.lang.Integer numUniqueUsersThreshold; + + /** + * This field is only meaningful for suggestions generated from user events or search history. If + * a query shows up less than this threshold, it may indicate that the query is rarely searched + * and thus will not be generated as a suggestion. This is field can be helpful for preventing PII + * queries becoming suggestions, as those queries are usually uniquely searched. If not set, the + * default value is 8 used in the generation pipeline. + * The value may be {@code null}. + */ + @com.google.api.client.util.Key + private java.lang.Integer queryFrequencyThreshold; + + /** + * The data model of query suggestions for serving. Currently supported values: * `automatic` - + * autocomplete backend automatic selects or mixes suggestions from different models. * `document` + * - Using suggestions generated from user-imported documents. * `search-history` - Using + * suggestions generated from the past history of SearchService.Search API calls. Do not use it + * when there is no traffic for Search API. * `user-event` - Using suggestions generated from + * user-imported search events. * `document-completable` - Using suggestions taken directly from + * user-imported document fields marked as completable. If query model is empty, the serving + * applies the "automatic" model by default. + * The value may be {@code null}. + */ + @com.google.api.client.util.Key + private java.lang.String queryModel; + + /** + * Whether to generate and serve content suggestions. This allows for content suggestions to be + * served in addition to query suggestions. + * The value may be {@code null}. + */ + @com.google.api.client.util.Key + private java.lang.Boolean shouldServeContentSuggestions; + + /** + * The enable mode of autocomplete generation pipelines. If this field is unset, the server + * behavior defaults to CompletionConfig.EnableMode.AUTOMATIC. Applies to DataStore only. Ignored + * for Engine. + * @return value or {@code null} for none + */ + public java.lang.String getEnableMode() { + return enableMode; + } + + /** + * The enable mode of autocomplete generation pipelines. If this field is unset, the server + * behavior defaults to CompletionConfig.EnableMode.AUTOMATIC. Applies to DataStore only. Ignored + * for Engine. + * @param enableMode enableMode or {@code null} for none + */ + public GoogleCloudDiscoveryengineV1alphaCompletionConfig setEnableMode(java.lang.String enableMode) { + this.enableMode = enableMode; + return this; + } + + /** + * If true, with best effort, try to detect and remove the suggestions containing certain types of + * PII information. This detection is performated by + * [DLP](https://cloud.google.com/security/products/dlp) under the hood. + * @return value or {@code null} for none + */ + public java.lang.Boolean getFilterPiiSuggestionsUsingDlp() { + return filterPiiSuggestionsUsingDlp; + } + + /** + * If true, with best effort, try to detect and remove the suggestions containing certain types of + * PII information. This detection is performated by + * [DLP](https://cloud.google.com/security/products/dlp) under the hood. + * @param filterPiiSuggestionsUsingDlp filterPiiSuggestionsUsingDlp or {@code null} for none + */ + public GoogleCloudDiscoveryengineV1alphaCompletionConfig setFilterPiiSuggestionsUsingDlp(java.lang.Boolean filterPiiSuggestionsUsingDlp) { + this.filterPiiSuggestionsUsingDlp = filterPiiSuggestionsUsingDlp; + return this; + } + + /** + * The matching order for autocomplete suggestions, e.g., a query consisting of `sh` with `out-of- + * order` specified would suggest `women's shoes`, whereas a query of `red s` with `exact-prefix` + * specified would suggest `red shoes`. Currently supported values: * `out-of-order` * `exact- + * prefix` Default value: `exact-prefix`. + * @return value or {@code null} for none + */ + public java.lang.String getMatchingOrder() { + return matchingOrder; + } + + /** + * The matching order for autocomplete suggestions, e.g., a query consisting of `sh` with `out-of- + * order` specified would suggest `women's shoes`, whereas a query of `red s` with `exact-prefix` + * specified would suggest `red shoes`. Currently supported values: * `out-of-order` * `exact- + * prefix` Default value: `exact-prefix`. + * @param matchingOrder matchingOrder or {@code null} for none + */ + public GoogleCloudDiscoveryengineV1alphaCompletionConfig setMatchingOrder(java.lang.String matchingOrder) { + this.matchingOrder = matchingOrder; + return this; + } + + /** + * The maximum number of autocomplete suggestions returned per term. max_suggestions must lie + * within the range of [1, 20]. If not set or set to 0, it will be set to the default of 20 + * suggestions. + * @return value or {@code null} for none + */ + public java.lang.Integer getMaxSuggestions() { + return maxSuggestions; + } + + /** + * The maximum number of autocomplete suggestions returned per term. max_suggestions must lie + * within the range of [1, 20]. If not set or set to 0, it will be set to the default of 20 + * suggestions. + * @param maxSuggestions maxSuggestions or {@code null} for none + */ + public GoogleCloudDiscoveryengineV1alphaCompletionConfig setMaxSuggestions(java.lang.Integer maxSuggestions) { + this.maxSuggestions = maxSuggestions; + return this; + } + + /** + * The minimum number of characters needed to be typed in order to get suggestions. + * min_prefix_length must lie within the range of [1, 20]. If not set or set to 0, it will be set + * to the default of 1 character. + * @return value or {@code null} for none + */ + public java.lang.Integer getMinPrefixLength() { + return minPrefixLength; + } + + /** + * The minimum number of characters needed to be typed in order to get suggestions. + * min_prefix_length must lie within the range of [1, 20]. If not set or set to 0, it will be set + * to the default of 1 character. + * @param minPrefixLength minPrefixLength or {@code null} for none + */ + public GoogleCloudDiscoveryengineV1alphaCompletionConfig setMinPrefixLength(java.lang.Integer minPrefixLength) { + this.minPrefixLength = minPrefixLength; + return this; + } + + /** + * Required. Immutable. Fully qualified name `projects/locations/dataStores/completionConfig` + * `projects/locations/collections/dataStores/completionConfig` + * `projects/locations/collections/engines/completionConfig` + * @return value or {@code null} for none + */ + public java.lang.String getName() { + return name; + } + + /** + * Required. Immutable. Fully qualified name `projects/locations/dataStores/completionConfig` + * `projects/locations/collections/dataStores/completionConfig` + * `projects/locations/collections/engines/completionConfig` + * @param name name or {@code null} for none + */ + public GoogleCloudDiscoveryengineV1alphaCompletionConfig setName(java.lang.String name) { + this.name = name; + return this; + } + + /** + * This field is only meaningful for suggestions generated from user events or search history, + * which may have user ids attached. If the number of unique users that have searched a query is + * less than this threshold, the query will not be generated as a suggestion. This is field can be + * helpful for preventing PII queries becoming suggestions, as those queries are usually uniquely + * searched. If not set, the default value is 3 used in the generation pipeline. + * @return value or {@code null} for none + */ + public java.lang.Integer getNumUniqueUsersThreshold() { + return numUniqueUsersThreshold; + } + + /** + * This field is only meaningful for suggestions generated from user events or search history, + * which may have user ids attached. If the number of unique users that have searched a query is + * less than this threshold, the query will not be generated as a suggestion. This is field can be + * helpful for preventing PII queries becoming suggestions, as those queries are usually uniquely + * searched. If not set, the default value is 3 used in the generation pipeline. + * @param numUniqueUsersThreshold numUniqueUsersThreshold or {@code null} for none + */ + public GoogleCloudDiscoveryengineV1alphaCompletionConfig setNumUniqueUsersThreshold(java.lang.Integer numUniqueUsersThreshold) { + this.numUniqueUsersThreshold = numUniqueUsersThreshold; + return this; + } + + /** + * This field is only meaningful for suggestions generated from user events or search history. If + * a query shows up less than this threshold, it may indicate that the query is rarely searched + * and thus will not be generated as a suggestion. This is field can be helpful for preventing PII + * queries becoming suggestions, as those queries are usually uniquely searched. If not set, the + * default value is 8 used in the generation pipeline. + * @return value or {@code null} for none + */ + public java.lang.Integer getQueryFrequencyThreshold() { + return queryFrequencyThreshold; + } + + /** + * This field is only meaningful for suggestions generated from user events or search history. If + * a query shows up less than this threshold, it may indicate that the query is rarely searched + * and thus will not be generated as a suggestion. This is field can be helpful for preventing PII + * queries becoming suggestions, as those queries are usually uniquely searched. If not set, the + * default value is 8 used in the generation pipeline. + * @param queryFrequencyThreshold queryFrequencyThreshold or {@code null} for none + */ + public GoogleCloudDiscoveryengineV1alphaCompletionConfig setQueryFrequencyThreshold(java.lang.Integer queryFrequencyThreshold) { + this.queryFrequencyThreshold = queryFrequencyThreshold; + return this; + } + + /** + * The data model of query suggestions for serving. Currently supported values: * `automatic` - + * autocomplete backend automatic selects or mixes suggestions from different models. * `document` + * - Using suggestions generated from user-imported documents. * `search-history` - Using + * suggestions generated from the past history of SearchService.Search API calls. Do not use it + * when there is no traffic for Search API. * `user-event` - Using suggestions generated from + * user-imported search events. * `document-completable` - Using suggestions taken directly from + * user-imported document fields marked as completable. If query model is empty, the serving + * applies the "automatic" model by default. + * @return value or {@code null} for none + */ + public java.lang.String getQueryModel() { + return queryModel; + } + + /** + * The data model of query suggestions for serving. Currently supported values: * `automatic` - + * autocomplete backend automatic selects or mixes suggestions from different models. * `document` + * - Using suggestions generated from user-imported documents. * `search-history` - Using + * suggestions generated from the past history of SearchService.Search API calls. Do not use it + * when there is no traffic for Search API. * `user-event` - Using suggestions generated from + * user-imported search events. * `document-completable` - Using suggestions taken directly from + * user-imported document fields marked as completable. If query model is empty, the serving + * applies the "automatic" model by default. + * @param queryModel queryModel or {@code null} for none + */ + public GoogleCloudDiscoveryengineV1alphaCompletionConfig setQueryModel(java.lang.String queryModel) { + this.queryModel = queryModel; + return this; + } + + /** + * Whether to generate and serve content suggestions. This allows for content suggestions to be + * served in addition to query suggestions. + * @return value or {@code null} for none + */ + public java.lang.Boolean getShouldServeContentSuggestions() { + return shouldServeContentSuggestions; + } + + /** + * Whether to generate and serve content suggestions. This allows for content suggestions to be + * served in addition to query suggestions. + * @param shouldServeContentSuggestions shouldServeContentSuggestions or {@code null} for none + */ + public GoogleCloudDiscoveryengineV1alphaCompletionConfig setShouldServeContentSuggestions(java.lang.Boolean shouldServeContentSuggestions) { + this.shouldServeContentSuggestions = shouldServeContentSuggestions; + return this; + } + + @Override + public GoogleCloudDiscoveryengineV1alphaCompletionConfig set(String fieldName, Object value) { + return (GoogleCloudDiscoveryengineV1alphaCompletionConfig) super.set(fieldName, value); + } + + @Override + public GoogleCloudDiscoveryengineV1alphaCompletionConfig clone() { + return (GoogleCloudDiscoveryengineV1alphaCompletionConfig) super.clone(); + } + +} diff --git a/clients/google-api-services-discoveryengine/v1alpha/2.0.0/com/google/api/services/discoveryengine/v1alpha/model/GoogleCloudDiscoveryengineV1alphaEngine.java b/clients/google-api-services-discoveryengine/v1alpha/2.0.0/com/google/api/services/discoveryengine/v1alpha/model/GoogleCloudDiscoveryengineV1alphaEngine.java index de541813923..9b52630259a 100644 --- a/clients/google-api-services-discoveryengine/v1alpha/2.0.0/com/google/api/services/discoveryengine/v1alpha/model/GoogleCloudDiscoveryengineV1alphaEngine.java +++ b/clients/google-api-services-discoveryengine/v1alpha/2.0.0/com/google/api/services/discoveryengine/v1alpha/model/GoogleCloudDiscoveryengineV1alphaEngine.java @@ -132,7 +132,7 @@ public final class GoogleCloudDiscoveryengineV1alphaEngine extends com.google.ap * * `disable-onedrive-upload` * `disable-talk-to-content` * `disable-google-drive-upload` * * `disable-welcome-emails` * `disable-canvas` * `disable-canvas-workspace` * `disable-skills` * * `enable-end-user-sharing-with-groups` * `single-agent-orchestration` * `multi-agent- - * orchestration` + * orchestration` * `cross-product-intelligence` * The value may be {@code null}. */ @com.google.api.client.util.Key @@ -475,7 +475,7 @@ public GoogleCloudDiscoveryengineV1alphaEngine setDisplayName(java.lang.String d * * `disable-onedrive-upload` * `disable-talk-to-content` * `disable-google-drive-upload` * * `disable-welcome-emails` * `disable-canvas` * `disable-canvas-workspace` * `disable-skills` * * `enable-end-user-sharing-with-groups` * `single-agent-orchestration` * `multi-agent- - * orchestration` + * orchestration` * `cross-product-intelligence` * @return value or {@code null} for none */ public java.util.Map