Package animeshon.webpage.v1alpha1
Index
- Archive
- CreatePageRequest
- DeletePageRequest
- GetPageRequest
- ImportPageRequest
- ImportPageRequest.WebCacheOptions
- ImportPageResponse
- ImportPageResponse.ImportPageRemoteError
- ImportPageResponse.ImportPageResult
- ListPagesRequest
- ListPagesResponse
- Page
- QueryPageRequest
- QueryPageResponse
- QueryPageResponse.QueryPageError
- QueryPageResponse.QueryPageResult
- QueryRequest
- QueryResponse
- QueryResponse.QueryPageError
- QueryResponse.QueryPageResult
Archive
Query |
---|
rpc Query(QueryRequest) QueryResponse |
GetPage |
---|
rpc GetPage(GetPageRequest) Page |
ListPages |
---|
rpc ListPages(ListPagesRequest) ListPagesResponse |
QueryPage |
---|
rpc QueryPage(QueryPageRequest) QueryPageResponse |
CreatePage |
---|
rpc CreatePage(CreatePageRequest) Page |
ImportPage |
---|
rpc ImportPage(ImportPageRequest) ImportPageResponse |
DeletePage |
---|
rpc DeletePage(DeletePageRequest) .google.protobuf.Empty |
CreatePageRequest
Field | Description |
---|---|
parent | string The parent this page belongs to. |
page | Page The page to create. |
DeletePageRequest
Field | Description |
---|---|
name | string The name of the page to delete. |
GetPageRequest
Field | Description |
---|---|
name | string The name of the page to retrieve. |
selector | string The html selector to use to return the page content. |
ImportPageRequest
Field | Description |
---|---|
parent | string The site parent of the page. |
uri | string A publicly-accessible page HTTP/HTTPS URL. When fetching pages from HTTP/HTTPS URLs, Animeshon cannot guarantee that the request will be completed. Your request may fail if the specified host denies the request (e.g. due to request throttling or DoS prevention), or if Animeshon throttles requests to the site for abuse prevention. |
cache_options | ImportPageRequest.WebCacheOptions The web cache options to apply to the import request. |
ImportPageRequest.WebCacheOptions
The WebCache options to be used when importing a page from a public site.
Field | Description |
---|---|
refresh | bool If refresh is set to true the page is imported from the remote address regardless of an existing local cache, if the fetched page does not match the existing cache the new page is stored and a new resource is created, otherwise the existing (cached) resource is returned. |
ignore | bool If ignore is set to true no cache lookup is performed and the page is imported into a new resource. If both "ignore" and "refresh" are set to true then "refresh" has no effect. |
ImportPageResponse
Field | Description |
---|---|
oneof response result | ImportPageResponse.ImportPageResult If the operation was successful this field will return the imported page. |
oneof response error | ImportPageResponse.ImportPageRemoteError If the operation ended up in a failure due to an error with the remote server this field will provide more details about the failure. |
cache_hit | bool Whether this page was found in the cache. |
ImportPageResponse.ImportPageRemoteError
Field | Description |
---|---|
status_code | int32 The status code returned from the remote server. |
details | string The details related to the import failure. |
ImportPageResponse.ImportPageResult
Field | Description |
---|---|
name | string The page resource name. |
ListPagesRequest
Field | Description |
---|---|
parent | string The parent this page belongs to. |
page_size | int32 If unspecified, server will pick an appropriate default. |
page_token | string The value returned from the previous call. |
filter | string A filter to be applied to results. |
ListPagesResponse
Field | Description |
---|---|
pages | repeated Page The list of pages. |
next_page_token | string A token to retrieve next page of results. |
Page
Field | Description |
---|---|
name | string The name of the page. |
content | string The page content according to the html selector. |
QueryPageRequest
Field | Description |
---|---|
name | string The name of the page to query. |
query | string The query to perform on the document in declarative query language. |
QueryPageResponse
Field | Description |
---|---|
oneof response result | QueryPageResponse.QueryPageResult If the operation was successful this field will return the query result. |
oneof response error | QueryPageResponse.QueryPageError If the operation ended up in a failure due to an error with the query evaluation this field will provide more details about the failure. |
QueryPageResponse.QueryPageError
Field | Description |
---|---|
code | int32 The gRPC error code returned by the query. |
details | string Additional details of the evaluation error. |
QueryPageResponse.QueryPageResult
Field | Description |
---|---|
value | google.protobuf.Value The result of the query evaluation. |
QueryRequest
Field | Description |
---|---|
query | string The query to perform on the matching documents in FQL. |
pages | repeated string The batch list of page resource names to be used for evaluation. |
QueryResponse
Field | Description |
---|---|
name | string The evaluated page resource name. |
oneof response result | QueryResponse.QueryPageResult If the operation was successful this field will return the query result. |
oneof response error | QueryResponse.QueryPageError If the operation ended up in a failure due to an error with the query evaluation this field will provide more details about the failure. |
QueryResponse.QueryPageError
Field | Description |
---|---|
code | int32 The gRPC error code returned by the query. |
details | string Additional details of the evaluation error. |
QueryResponse.QueryPageResult
Field | Description |
---|---|
value | google.protobuf.Value The result of the query evaluation. |