Show / Hide Table of Contents

Class ProjectsResource.LocationsResource.SkillsResource.SearchRequest

Custom deep-search method to filter by frontmatter or query SKILL.md text blobs.

Inheritance
object
ClientServiceRequest
ClientServiceRequest<SearchSkillsResponse>
AgentRegistryBaseServiceRequest<SearchSkillsResponse>
ProjectsResource.LocationsResource.SkillsResource.SearchRequest
Implements
IClientServiceRequest<SearchSkillsResponse>
IClientServiceRequest
Inherited Members
AgentRegistryBaseServiceRequest<SearchSkillsResponse>.Xgafv
AgentRegistryBaseServiceRequest<SearchSkillsResponse>.AccessToken
AgentRegistryBaseServiceRequest<SearchSkillsResponse>.Alt
AgentRegistryBaseServiceRequest<SearchSkillsResponse>.Callback
AgentRegistryBaseServiceRequest<SearchSkillsResponse>.Fields
AgentRegistryBaseServiceRequest<SearchSkillsResponse>.Key
AgentRegistryBaseServiceRequest<SearchSkillsResponse>.OauthToken
AgentRegistryBaseServiceRequest<SearchSkillsResponse>.PrettyPrint
AgentRegistryBaseServiceRequest<SearchSkillsResponse>.QuotaUser
AgentRegistryBaseServiceRequest<SearchSkillsResponse>.UploadType
AgentRegistryBaseServiceRequest<SearchSkillsResponse>.UploadProtocol
ClientServiceRequest<SearchSkillsResponse>.Execute()
ClientServiceRequest<SearchSkillsResponse>.ExecuteAsStream()
ClientServiceRequest<SearchSkillsResponse>.ExecuteAsync()
ClientServiceRequest<SearchSkillsResponse>.ExecuteAsync(CancellationToken)
ClientServiceRequest<SearchSkillsResponse>.ExecuteAsStreamAsync()
ClientServiceRequest<SearchSkillsResponse>.ExecuteAsStreamAsync(CancellationToken)
ClientServiceRequest<SearchSkillsResponse>.CreateRequest(bool?)
ClientServiceRequest<SearchSkillsResponse>.GenerateRequestUri()
ClientServiceRequest<SearchSkillsResponse>.GetBody()
ClientServiceRequest<SearchSkillsResponse>.GetDefaultETagAction(string)
ClientServiceRequest<SearchSkillsResponse>.ETagAction
ClientServiceRequest<SearchSkillsResponse>.ModifyRequest
ClientServiceRequest<SearchSkillsResponse>.ValidateParameters
ClientServiceRequest<SearchSkillsResponse>.ApiVersion
ClientServiceRequest<SearchSkillsResponse>.RequestParameters
ClientServiceRequest<SearchSkillsResponse>.Service
ClientServiceRequest._unsuccessfulResponseHandlers
ClientServiceRequest._exceptionHandlers
ClientServiceRequest._executeInterceptors
ClientServiceRequest.AddUnsuccessfulResponseHandler(IHttpUnsuccessfulResponseHandler)
ClientServiceRequest.AddExceptionHandler(IHttpExceptionHandler)
ClientServiceRequest.AddExecuteInterceptor(IHttpExecuteInterceptor)
ClientServiceRequest.Credential
object.Equals(object)
object.Equals(object, object)
object.GetHashCode()
object.GetType()
object.MemberwiseClone()
object.ReferenceEquals(object, object)
object.ToString()
Namespace: Google.Apis.AgentRegistry.v1alpha
Assembly: Google.Apis.AgentRegistry.v1alpha.dll
Syntax
public class ProjectsResource.LocationsResource.SkillsResource.SearchRequest : AgentRegistryBaseServiceRequest<SearchSkillsResponse>, IClientServiceRequest<SearchSkillsResponse>, IClientServiceRequest

Constructors

SearchRequest(IClientService, string)

Constructs a new Search request.

Declaration
public SearchRequest(IClientService service, string parent)
Parameters
Type Name Description
IClientService service
string parent

Properties

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 for more details. Allowed operators: =, &lt;, &gt;, NOT, AND, OR, and (). | Field | = | &lt;, &gt; | |--------------|-----|----------| | state | Yes | No | | targetState | Yes | No | | createTime | Yes | Yes | | updateTime | Yes | Yes | Examples: * state=ACTIVE to restrict results to skills in the ACTIVE state.

Declaration
[RequestParameter("filter", RequestParameterType.Query)]
public virtual string Filter { get; set; }
Property Value
Type Description
string

HttpMethod

Gets the HTTP method.

Declaration
public override string HttpMethod { get; }
Property Value
Type Description
string
Overrides
ClientServiceRequest<SearchSkillsResponse>.HttpMethod

MethodName

Gets the method name.

Declaration
public override string MethodName { get; }
Property Value
Type Description
string
Overrides
ClientServiceRequest<SearchSkillsResponse>.MethodName

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.

Declaration
[RequestParameter("pageSize", RequestParameterType.Query)]
public virtual int? PageSize { get; set; }
Property Value
Type Description
int?

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.

Declaration
[RequestParameter("pageToken", RequestParameterType.Query)]
public virtual string PageToken { get; set; }
Property Value
Type Description
string

Parent

Required. Parent value for SearchSkillsRequest. Format: projects/{project}/locations/{location}.

Declaration
[RequestParameter("parent", RequestParameterType.Path)]
public virtual string Parent { get; }
Property Value
Type Description
string

RestPath

Gets the REST path.

Declaration
public override string RestPath { get; }
Property Value
Type Description
string
Overrides
ClientServiceRequest<SearchSkillsResponse>.RestPath

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 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.

Declaration
[RequestParameter("searchString", RequestParameterType.Query)]
public virtual string SearchString { get; set; }
Property Value
Type Description
string

SearchType

Optional. The type of search.

Declaration
[RequestParameter("searchType", RequestParameterType.Query)]
public virtual ProjectsResource.LocationsResource.SkillsResource.SearchRequest.SearchTypeEnum? SearchType { get; set; }
Property Value
Type Description
ProjectsResource.LocationsResource.SkillsResource.SearchRequest.SearchTypeEnum?

Methods

InitParameters()

Initializes Search parameter list.

Declaration
protected override void InitParameters()
Overrides
AgentRegistryBaseServiceRequest<SearchSkillsResponse>.InitParameters()

Implements

IClientServiceRequest<TResponse>
IClientServiceRequest
In this article
Back to top Generated by DocFX