| 1 |
<html><body> |
| 2 |
<style> |
| 3 |
|
| 4 |
body, h1, h2, h3, div, span, p, pre, a { |
| 5 |
margin: 0; |
| 6 |
padding: 0; |
| 7 |
border: 0; |
| 8 |
font-weight: inherit; |
| 9 |
font-style: inherit; |
| 10 |
font-size: 100%; |
| 11 |
font-family: inherit; |
| 12 |
vertical-align: baseline; |
| 13 |
} |
| 14 |
|
| 15 |
body { |
| 16 |
font-size: 13px; |
| 17 |
padding: 1em; |
| 18 |
} |
| 19 |
|
| 20 |
h1 { |
| 21 |
font-size: 26px; |
| 22 |
margin-bottom: 1em; |
| 23 |
} |
| 24 |
|
| 25 |
h2 { |
| 26 |
font-size: 24px; |
| 27 |
margin-bottom: 1em; |
| 28 |
} |
| 29 |
|
| 30 |
h3 { |
| 31 |
font-size: 20px; |
| 32 |
margin-bottom: 1em; |
| 33 |
margin-top: 1em; |
| 34 |
} |
| 35 |
|
| 36 |
pre, code { |
| 37 |
line-height: 1.5; |
| 38 |
font-family: Monaco, 'DejaVu Sans Mono', 'Bitstream Vera Sans Mono', 'Lucida Console', monospace; |
| 39 |
} |
| 40 |
|
| 41 |
pre { |
| 42 |
margin-top: 0.5em; |
| 43 |
} |
| 44 |
|
| 45 |
h1, h2, h3, p { |
| 46 |
font-family: Arial, sans serif; |
| 47 |
} |
| 48 |
|
| 49 |
h1, h2, h3 { |
| 50 |
border-bottom: solid #CCC 1px; |
| 51 |
} |
| 52 |
|
| 53 |
.toc_element { |
| 54 |
margin-top: 0.5em; |
| 55 |
} |
| 56 |
|
| 57 |
.firstline { |
| 58 |
margin-left: 2 em; |
| 59 |
} |
| 60 |
|
| 61 |
.method { |
| 62 |
margin-top: 1em; |
| 63 |
border: solid 1px #CCC; |
| 64 |
padding: 1em; |
| 65 |
background: #EEE; |
| 66 |
} |
| 67 |
|
| 68 |
.details { |
| 69 |
font-weight: bold; |
| 70 |
font-size: 14px; |
| 71 |
} |
| 72 |
|
| 73 |
</style> |
| 74 |
|
| 75 |
<h1><a href="discoveryengine_v1.html">Discovery Engine API</a> . <a href="discoveryengine_v1.projects.html">projects</a> . <a href="discoveryengine_v1.projects.locations.html">locations</a> . <a href="discoveryengine_v1.projects.locations.collections.html">collections</a> . <a href="discoveryengine_v1.projects.locations.collections.dataStores.html">dataStores</a> . <a href="discoveryengine_v1.projects.locations.collections.dataStores.siteSearchEngine.html">siteSearchEngine</a> . <a href="discoveryengine_v1.projects.locations.collections.dataStores.siteSearchEngine.sitemaps.html">sitemaps</a></h1> |
| 76 |
<h2>Instance Methods</h2> |
| 77 |
<p class="toc_element"> |
| 78 |
<code><a href="#close">close()</a></code></p> |
| 79 |
<p class="firstline">Close httplib2 connections.</p> |
| 80 |
<p class="toc_element"> |
| 81 |
<code><a href="#create">create(parent, body=None, x__xgafv=None)</a></code></p> |
| 82 |
<p class="firstline">Creates a Sitemap.</p> |
| 83 |
<p class="toc_element"> |
| 84 |
<code><a href="#delete">delete(name, x__xgafv=None)</a></code></p> |
| 85 |
<p class="firstline">Deletes a Sitemap.</p> |
| 86 |
<p class="toc_element"> |
| 87 |
<code><a href="#fetch">fetch(parent, matcher_urisMatcher_uris=None, x__xgafv=None)</a></code></p> |
| 88 |
<p class="firstline">Fetch Sitemaps in a DataStore.</p> |
| 89 |
<h3>Method Details</h3> |
| 90 |
<div class="method"> |
| 91 |
<code class="details" id="close">close()</code> |
| 92 |
<pre>Close httplib2 connections.</pre> |
| 93 |
</div> |
| 94 |
|
| 95 |
<div class="method"> |
| 96 |
<code class="details" id="create">create(parent, body=None, x__xgafv=None)</code> |
| 97 |
<pre>Creates a Sitemap. |
| 98 |
|
| 99 |
Args: |
| 100 |
parent: string, Required. Parent resource name of the SiteSearchEngine, such as `projects/*/locations/*/collections/*/dataStores/*/siteSearchEngine`. (required) |
| 101 |
body: object, The request body. |
| 102 |
The object takes the form of: |
| 103 |
|
| 104 |
{ # A sitemap for the SiteSearchEngine. |
| 105 |
"createTime": "A String", # Output only. The sitemap's creation time. |
| 106 |
"name": "A String", # Output only. The fully qualified resource name of the sitemap. `projects/*/locations/*/collections/*/dataStores/*/siteSearchEngine/sitemaps/*` The `sitemap_id` suffix is system-generated. |
| 107 |
"uri": "A String", # Public URI for the sitemap, e.g. `www.example.com/sitemap.xml`. |
| 108 |
} |
| 109 |
|
| 110 |
x__xgafv: string, V1 error format. |
| 111 |
Allowed values |
| 112 |
1 - v1 error format |
| 113 |
2 - v2 error format |
| 114 |
|
| 115 |
Returns: |
| 116 |
An object of the form: |
| 117 |
|
| 118 |
{ # This resource represents a long-running operation that is the result of a network API call. |
| 119 |
"done": True or False, # If the value is `false`, it means the operation is still in progress. If `true`, the operation is completed, and either `error` or `response` is available. |
| 120 |
"error": { # The `Status` type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by [gRPC](https://github.com/grpc). Each `Status` message contains three pieces of data: error code, error message, and error details. You can find out more about this error model and how to work with it in the [API Design Guide](https://cloud.google.com/apis/design/errors). # The error result of the operation in case of failure or cancellation. |
| 121 |
"code": 42, # The status code, which should be an enum value of google.rpc.Code. |
| 122 |
"details": [ # A list of messages that carry the error details. There is a common set of message types for APIs to use. |
| 123 |
{ |
| 124 |
"a_key": "", # Properties of the object. Contains field @type with type URL. |
| 125 |
}, |
| 126 |
], |
| 127 |
"message": "A String", # A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client. |
| 128 |
}, |
| 129 |
"metadata": { # Service-specific metadata associated with the operation. It typically contains progress information and common metadata such as create time. Some services might not provide such metadata. Any method that returns a long-running operation should document the metadata type, if any. |
| 130 |
"a_key": "", # Properties of the object. Contains field @type with type URL. |
| 131 |
}, |
| 132 |
"name": "A String", # The server-assigned name, which is only unique within the same service that originally returns it. If you use the default HTTP mapping, the `name` should be a resource name ending with `operations/{unique_id}`. |
| 133 |
"response": { # The normal, successful response of the operation. If the original method returns no data on success, such as `Delete`, the response is `google.protobuf.Empty`. If the original method is standard `Get`/`Create`/`Update`, the response should be the resource. For other methods, the response should have the type `XxxResponse`, where `Xxx` is the original method name. For example, if the original method name is `TakeSnapshot()`, the inferred response type is `TakeSnapshotResponse`. |
| 134 |
"a_key": "", # Properties of the object. Contains field @type with type URL. |
| 135 |
}, |
| 136 |
}</pre> |
| 137 |
</div> |
| 138 |
|
| 139 |
<div class="method"> |
| 140 |
<code class="details" id="delete">delete(name, x__xgafv=None)</code> |
| 141 |
<pre>Deletes a Sitemap. |
| 142 |
|
| 143 |
Args: |
| 144 |
name: string, Required. Full resource name of Sitemap, such as `projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}/siteSearchEngine/sitemaps/{sitemap}`. If the caller does not have permission to access the Sitemap, regardless of whether or not it exists, a PERMISSION_DENIED error is returned. If the requested Sitemap does not exist, a NOT_FOUND error is returned. (required) |
| 145 |
x__xgafv: string, V1 error format. |
| 146 |
Allowed values |
| 147 |
1 - v1 error format |
| 148 |
2 - v2 error format |
| 149 |
|
| 150 |
Returns: |
| 151 |
An object of the form: |
| 152 |
|
| 153 |
{ # This resource represents a long-running operation that is the result of a network API call. |
| 154 |
"done": True or False, # If the value is `false`, it means the operation is still in progress. If `true`, the operation is completed, and either `error` or `response` is available. |
| 155 |
"error": { # The `Status` type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by [gRPC](https://github.com/grpc). Each `Status` message contains three pieces of data: error code, error message, and error details. You can find out more about this error model and how to work with it in the [API Design Guide](https://cloud.google.com/apis/design/errors). # The error result of the operation in case of failure or cancellation. |
| 156 |
"code": 42, # The status code, which should be an enum value of google.rpc.Code. |
| 157 |
"details": [ # A list of messages that carry the error details. There is a common set of message types for APIs to use. |
| 158 |
{ |
| 159 |
"a_key": "", # Properties of the object. Contains field @type with type URL. |
| 160 |
}, |
| 161 |
], |
| 162 |
"message": "A String", # A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client. |
| 163 |
}, |
| 164 |
"metadata": { # Service-specific metadata associated with the operation. It typically contains progress information and common metadata such as create time. Some services might not provide such metadata. Any method that returns a long-running operation should document the metadata type, if any. |
| 165 |
"a_key": "", # Properties of the object. Contains field @type with type URL. |
| 166 |
}, |
| 167 |
"name": "A String", # The server-assigned name, which is only unique within the same service that originally returns it. If you use the default HTTP mapping, the `name` should be a resource name ending with `operations/{unique_id}`. |
| 168 |
"response": { # The normal, successful response of the operation. If the original method returns no data on success, such as `Delete`, the response is `google.protobuf.Empty`. If the original method is standard `Get`/`Create`/`Update`, the response should be the resource. For other methods, the response should have the type `XxxResponse`, where `Xxx` is the original method name. For example, if the original method name is `TakeSnapshot()`, the inferred response type is `TakeSnapshotResponse`. |
| 169 |
"a_key": "", # Properties of the object. Contains field @type with type URL. |
| 170 |
}, |
| 171 |
}</pre> |
| 172 |
</div> |
| 173 |
|
| 174 |
<div class="method"> |
| 175 |
<code class="details" id="fetch">fetch(parent, matcher_urisMatcher_uris=None, x__xgafv=None)</code> |
| 176 |
<pre>Fetch Sitemaps in a DataStore. |
| 177 |
|
| 178 |
Args: |
| 179 |
parent: string, Required. Parent resource name of the SiteSearchEngine, such as `projects/*/locations/*/collections/*/dataStores/*/siteSearchEngine`. (required) |
| 180 |
matcher_urisMatcher_uris: string, The Sitemap uris. (repeated) |
| 181 |
x__xgafv: string, V1 error format. |
| 182 |
Allowed values |
| 183 |
1 - v1 error format |
| 184 |
2 - v2 error format |
| 185 |
|
| 186 |
Returns: |
| 187 |
An object of the form: |
| 188 |
|
| 189 |
{ # Response message for SiteSearchEngineService.FetchSitemaps method. |
| 190 |
"sitemapsMetadata": [ # List of Sitemaps fetched. |
| 191 |
{ # Contains a Sitemap and its metadata. |
| 192 |
"sitemap": { # A sitemap for the SiteSearchEngine. # The Sitemap. |
| 193 |
"createTime": "A String", # Output only. The sitemap's creation time. |
| 194 |
"name": "A String", # Output only. The fully qualified resource name of the sitemap. `projects/*/locations/*/collections/*/dataStores/*/siteSearchEngine/sitemaps/*` The `sitemap_id` suffix is system-generated. |
| 195 |
"uri": "A String", # Public URI for the sitemap, e.g. `www.example.com/sitemap.xml`. |
| 196 |
}, |
| 197 |
}, |
| 198 |
], |
| 199 |
}</pre> |
| 200 |
</div> |
| 201 |
|
| 202 |
</body></html> |