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 Agent Registry 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 SearchSkillsRequest extends com.google.api.client.json.GenericJson { + + /** + * Optional. Use this field to specify additional filter criteria on search results. Filter + * expressions can be used to restrict results based upon filterable fields, where equality + * operators can be used. See [instructions](https://docs.cloud.google.com/agent-registry/search- + * agents-and-tools) for more details. Allowed operators: `=`, `<`, `>`, `NOT`, `AND`, `OR`, and + * `()`. | Field | `=` | `<`, `>` | |--------------|-----|----------| | state | Yes | No | | + * targetState | Yes | No | | createTime | Yes | Yes | | updateTime | Yes | Yes | Examples: * + * `state=ACTIVE` to restrict results to skills in the `ACTIVE` state. + * The value may be {@code null}. + */ + @com.google.api.client.util.Key + private java.lang.String filter; + + /** + * Optional. The maximum number of search results to return per page. The page size is capped at + * `100`, even if a larger value is specified. A negative value will result in an + * `INVALID_ARGUMENT` error. If unspecified or set to `0`, a default value of `20` will be used. + * The server may return fewer results than requested. + * The value may be {@code null}. + */ + @com.google.api.client.util.Key + private java.lang.Integer pageSize; + + /** + * Optional. If present, retrieve the next batch of results from the preceding call to this + * method. `page_token` must be the value of `next_page_token` from the previous response. The + * values of all other method parameters, must be identical to those in the previous call. + * The value may be {@code null}. + */ + @com.google.api.client.util.Key + private java.lang.String pageToken; + + /** + * Optional. Search criteria used to select the Skills to return. If no search criteria is + * specified then all accessible Skills will be returned. Search expressions can be used to + * restrict results based upon searchable fields, where the operators can be used along with the + * suffix wildcard symbol `*`. See [instructions](https://docs.cloud.google.com/agent- + * registry/search-agents-and-tools) for more details. Allowed operators: `=`, `:`, `NOT`, `AND`, + * `OR`, and `()`. Searchable fields: | Field | `=` | `:` | `*` | Keyword Search | + * |---------------------------|-----|-----|-----|----------------| | skillId | Yes | Yes | Yes | + * Included | | name | No | Yes | Yes | Included | | displayName | No | Yes | Yes | Included | | + * description | No | Yes | No | Included | | frontmatter.name | No | Yes | No | Included | | + * frontmatter.description | No | Yes | No | Included | | frontmatter.compatibility | No | Yes | + * No | Included | | frontmatter.license | No | Yes | No | Included | Examples: * + * `skillId="urn:skill:projects-1234:locations:global:private-important-skill"` to find the skill + * with the specified skill ID. * `name:important` to find skills whose name contains `important` + * as a word. * `displayName:works*` to find skills whose display name contains words that start + * with `works`. + * The value may be {@code null}. + */ + @com.google.api.client.util.Key + private java.lang.String searchString; + + /** + * Optional. The type of search. + * The value may be {@code null}. + */ + @com.google.api.client.util.Key + private java.lang.String searchType; + + /** + * Optional. Use this field to specify additional filter criteria on search results. Filter + * expressions can be used to restrict results based upon filterable fields, where equality + * operators can be used. See [instructions](https://docs.cloud.google.com/agent-registry/search- + * agents-and-tools) for more details. Allowed operators: `=`, `<`, `>`, `NOT`, `AND`, `OR`, and + * `()`. | Field | `=` | `<`, `>` | |--------------|-----|----------| | state | Yes | No | | + * targetState | Yes | No | | createTime | Yes | Yes | | updateTime | Yes | Yes | Examples: * + * `state=ACTIVE` to restrict results to skills in the `ACTIVE` state. + * @return value or {@code null} for none + */ + public java.lang.String getFilter() { + return filter; + } + + /** + * Optional. Use this field to specify additional filter criteria on search results. Filter + * expressions can be used to restrict results based upon filterable fields, where equality + * operators can be used. See [instructions](https://docs.cloud.google.com/agent-registry/search- + * agents-and-tools) for more details. Allowed operators: `=`, `<`, `>`, `NOT`, `AND`, `OR`, and + * `()`. | Field | `=` | `<`, `>` | |--------------|-----|----------| | state | Yes | No | | + * targetState | Yes | No | | createTime | Yes | Yes | | updateTime | Yes | Yes | Examples: * + * `state=ACTIVE` to restrict results to skills in the `ACTIVE` state. + * @param filter filter or {@code null} for none + */ + public SearchSkillsRequest setFilter(java.lang.String filter) { + this.filter = filter; + return this; + } + + /** + * Optional. The maximum number of search results to return per page. The page size is capped at + * `100`, even if a larger value is specified. A negative value will result in an + * `INVALID_ARGUMENT` error. If unspecified or set to `0`, a default value of `20` will be used. + * The server may return fewer results than requested. + * @return value or {@code null} for none + */ + public java.lang.Integer getPageSize() { + return pageSize; + } + + /** + * Optional. The maximum number of search results to return per page. The page size is capped at + * `100`, even if a larger value is specified. A negative value will result in an + * `INVALID_ARGUMENT` error. If unspecified or set to `0`, a default value of `20` will be used. + * The server may return fewer results than requested. + * @param pageSize pageSize or {@code null} for none + */ + public SearchSkillsRequest setPageSize(java.lang.Integer pageSize) { + this.pageSize = pageSize; + return this; + } + + /** + * Optional. If present, retrieve the next batch of results from the preceding call to this + * method. `page_token` must be the value of `next_page_token` from the previous response. The + * values of all other method parameters, must be identical to those in the previous call. + * @return value or {@code null} for none + */ + public java.lang.String getPageToken() { + return pageToken; + } + + /** + * Optional. If present, retrieve the next batch of results from the preceding call to this + * method. `page_token` must be the value of `next_page_token` from the previous response. The + * values of all other method parameters, must be identical to those in the previous call. + * @param pageToken pageToken or {@code null} for none + */ + public SearchSkillsRequest setPageToken(java.lang.String pageToken) { + this.pageToken = pageToken; + return this; + } + + /** + * Optional. Search criteria used to select the Skills to return. If no search criteria is + * specified then all accessible Skills will be returned. Search expressions can be used to + * restrict results based upon searchable fields, where the operators can be used along with the + * suffix wildcard symbol `*`. See [instructions](https://docs.cloud.google.com/agent- + * registry/search-agents-and-tools) for more details. Allowed operators: `=`, `:`, `NOT`, `AND`, + * `OR`, and `()`. Searchable fields: | Field | `=` | `:` | `*` | Keyword Search | + * |---------------------------|-----|-----|-----|----------------| | skillId | Yes | Yes | Yes | + * Included | | name | No | Yes | Yes | Included | | displayName | No | Yes | Yes | Included | | + * description | No | Yes | No | Included | | frontmatter.name | No | Yes | No | Included | | + * frontmatter.description | No | Yes | No | Included | | frontmatter.compatibility | No | Yes | + * No | Included | | frontmatter.license | No | Yes | No | Included | Examples: * + * `skillId="urn:skill:projects-1234:locations:global:private-important-skill"` to find the skill + * with the specified skill ID. * `name:important` to find skills whose name contains `important` + * as a word. * `displayName:works*` to find skills whose display name contains words that start + * with `works`. + * @return value or {@code null} for none + */ + public java.lang.String getSearchString() { + return searchString; + } + + /** + * Optional. Search criteria used to select the Skills to return. If no search criteria is + * specified then all accessible Skills will be returned. Search expressions can be used to + * restrict results based upon searchable fields, where the operators can be used along with the + * suffix wildcard symbol `*`. See [instructions](https://docs.cloud.google.com/agent- + * registry/search-agents-and-tools) for more details. Allowed operators: `=`, `:`, `NOT`, `AND`, + * `OR`, and `()`. Searchable fields: | Field | `=` | `:` | `*` | Keyword Search | + * |---------------------------|-----|-----|-----|----------------| | skillId | Yes | Yes | Yes | + * Included | | name | No | Yes | Yes | Included | | displayName | No | Yes | Yes | Included | | + * description | No | Yes | No | Included | | frontmatter.name | No | Yes | No | Included | | + * frontmatter.description | No | Yes | No | Included | | frontmatter.compatibility | No | Yes | + * No | Included | | frontmatter.license | No | Yes | No | Included | Examples: * + * `skillId="urn:skill:projects-1234:locations:global:private-important-skill"` to find the skill + * with the specified skill ID. * `name:important` to find skills whose name contains `important` + * as a word. * `displayName:works*` to find skills whose display name contains words that start + * with `works`. + * @param searchString searchString or {@code null} for none + */ + public SearchSkillsRequest setSearchString(java.lang.String searchString) { + this.searchString = searchString; + return this; + } + + /** + * Optional. The type of search. + * @return value or {@code null} for none + */ + public java.lang.String getSearchType() { + return searchType; + } + + /** + * Optional. The type of search. + * @param searchType searchType or {@code null} for none + */ + public SearchSkillsRequest setSearchType(java.lang.String searchType) { + this.searchType = searchType; + return this; + } + + @Override + public SearchSkillsRequest set(String fieldName, Object value) { + return (SearchSkillsRequest) super.set(fieldName, value); + } + + @Override + public SearchSkillsRequest clone() { + return (SearchSkillsRequest) super.clone(); + } + +} diff --git a/clients/google-api-services-agentregistry/v1alpha/2.0.0/pom.xml b/clients/google-api-services-agentregistry/v1alpha/2.0.0/pom.xml index 953a4491cf9..6102990b575 100644 --- a/clients/google-api-services-agentregistry/v1alpha/2.0.0/pom.xml +++ b/clients/google-api-services-agentregistry/v1alpha/2.0.0/pom.xml @@ -8,8 +8,8 @@