Debian Codegraph @

docs/dyn/discoveryengine_v1.projects.html

raw
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></h1>
76 <h2>Instance Methods</h2>
77 <p class="toc_element">
78 <code><a href="discoveryengine_v1.projects.locations.html">locations()</a></code>
79 </p>
80 <p class="firstline">Returns the locations Resource.</p>
81
82 <p class="toc_element">
83 <code><a href="discoveryengine_v1.projects.operations.html">operations()</a></code>
84 </p>
85 <p class="firstline">Returns the operations Resource.</p>
86
87 <p class="toc_element">
88 <code><a href="#close">close()</a></code></p>
89 <p class="firstline">Close httplib2 connections.</p>
90 <p class="toc_element">
91 <code><a href="#provision">provision(name, body=None, x__xgafv=None)</a></code></p>
92 <p class="firstline">Provisions the project resource. During the process, related systems will get prepared and initialized. Caller must read the [Terms for data use](https://cloud.google.com/retail/data-use-terms), and optionally specify in request to provide consent to that service terms.</p>
93 <h3>Method Details</h3>
94 <div class="method">
95 <code class="details" id="close">close()</code>
96 <pre>Close httplib2 connections.</pre>
97 </div>
98
99 <div class="method">
100 <code class="details" id="provision">provision(name, body=None, x__xgafv=None)</code>
101 <pre>Provisions the project resource. During the process, related systems will get prepared and initialized. Caller must read the [Terms for data use](https://cloud.google.com/retail/data-use-terms), and optionally specify in request to provide consent to that service terms.
102
103 Args:
104 name: string, Required. Full resource name of a Project, such as `projects/{project_id_or_number}`. (required)
105 body: object, The request body.
106 The object takes the form of:
107
108 { # Request for ProjectService.ProvisionProject method.
109 &quot;acceptDataUseTerms&quot;: True or False, # Required. Set to `true` to specify that caller has read and would like to give consent to the [Terms for data use](https://cloud.google.com/retail/data-use-terms).
110 &quot;dataUseTermsVersion&quot;: &quot;A String&quot;, # Required. The version of the [Terms for data use](https://cloud.google.com/retail/data-use-terms) that caller has read and would like to give consent to. Acceptable version is `2022-11-23`, and this may change over time.
111 &quot;saasParams&quot;: { # Parameters for Agentspace. # Optional. Parameters for Agentspace.
112 &quot;acceptBizQos&quot;: True or False, # Optional. Set to `true` to specify that caller has read and would like to give consent to the [Terms for Agent Space quality of service].
113 &quot;isBiz&quot;: True or False, # Optional. Indicates if the current request is for Biz edition (= true) or not (= false).
114 },
115 }
116
117 x__xgafv: string, V1 error format.
118 Allowed values
119 1 - v1 error format
120 2 - v2 error format
121
122 Returns:
123 An object of the form:
124
125 { # This resource represents a long-running operation that is the result of a network API call.
126 &quot;done&quot;: 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.
127 &quot;error&quot;: { # 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.
128 &quot;code&quot;: 42, # The status code, which should be an enum value of google.rpc.Code.
129 &quot;details&quot;: [ # A list of messages that carry the error details. There is a common set of message types for APIs to use.
130 {
131 &quot;a_key&quot;: &quot;&quot;, # Properties of the object. Contains field @type with type URL.
132 },
133 ],
134 &quot;message&quot;: &quot;A String&quot;, # 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.
135 },
136 &quot;metadata&quot;: { # 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.
137 &quot;a_key&quot;: &quot;&quot;, # Properties of the object. Contains field @type with type URL.
138 },
139 &quot;name&quot;: &quot;A String&quot;, # 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}`.
140 &quot;response&quot;: { # 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`.
141 &quot;a_key&quot;: &quot;&quot;, # Properties of the object. Contains field @type with type URL.
142 },
143 }</pre>
144 </div>
145
146 </body></html>