Gitiles
Code Review Sign In
gerrit-public.fairphone.software / platform / external / python / google-api-python-client / 673ec5cf1a654055c85c0d426b27d270a8ade262 / . / docs / dyn / domainsrdap_v1.ip.html
blob: c15d6c4f420a1fbbf776d378b5a3a82a19dbefdb [file] [log] [blame]
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]1<html><body>
2<style>
3
4body, 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
15body {
16 font-size: 13px;
17 padding: 1em;
18}
19
20h1 {
21 font-size: 26px;
22 margin-bottom: 1em;
23}
24
25h2 {
26 font-size: 24px;
27 margin-bottom: 1em;
28}
29
30h3 {
31 font-size: 20px;
32 margin-bottom: 1em;
33 margin-top: 1em;
34}
35
36pre, code {
37 line-height: 1.5;
38 font-family: Monaco, 'DejaVu Sans Mono', 'Bitstream Vera Sans Mono', 'Lucida Console', monospace;
39}
40
41pre {
42 margin-top: 0.5em;
43}
44
45h1, h2, h3, p {
46 font-family: Arial, sans serif;
47}
48
49h1, 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="domainsrdap_v1.html">Domains RDAP API</a> . <a href="domainsrdap_v1.ip.html">ip</a></h1>
76<h2>Instance Methods</h2>
77<p class="toc_element">
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700[diff] [blame]78 <code><a href="#close">close()</a></code></p>
79<p class="firstline">Close httplib2 connections.</p>
80<p class="toc_element">
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]81 <code><a href="#get">get(ipId, ipId1, x__xgafv=None)</a></code></p>
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700[diff] [blame]82<p class="firstline">The RDAP API recognizes this command from the RDAP specification but does not support it. The response is a formatted 501 error.</p>
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]83<h3>Method Details</h3>
84<div class="method">
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700[diff] [blame]85 <code class="details" id="close">close()</code>
86 <pre>Close httplib2 connections.</pre>
87</div>
88
89<div class="method">
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]90 <code class="details" id="get">get(ipId, ipId1, x__xgafv=None)</code>
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700[diff] [blame]91 <pre>The RDAP API recognizes this command from the RDAP specification but does not support it. The response is a formatted 501 error.
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]92
93Args:
94 ipId: string, A parameter (required)
95 ipId1: string, A parameter (required)
96 x__xgafv: string, V1 error format.
97 Allowed values
98 1 - v1 error format
99 2 - v2 error format
100
101Returns:
102 An object of the form:
103
104 { # Response to a general RDAP query.
Bu Sun Kim673ec5c2020-11-16 11:05:03 -0700[diff] [blame^]105 &quot;title&quot;: &quot;A String&quot;, # Error title.
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700[diff] [blame]106 &quot;jsonResponse&quot;: { # Message that represents an arbitrary HTTP body. It should only be used for payload formats that can&#x27;t be represented as JSON, such as raw binary or an HTML page. This message can be used both in streaming and non-streaming API methods in the request as well as the response. It can be used as a top-level request field, which is convenient if one wants to extract parameters from either the URL or HTTP template into the request fields and also want access to the raw HTTP body. Example: message GetResourceRequest { // A unique request id. string request_id = 1; // The raw HTTP body is bound to this field. google.api.HttpBody http_body = 2; } service ResourceService { rpc GetResource(GetResourceRequest) returns (google.api.HttpBody); rpc UpdateResource(google.api.HttpBody) returns (google.protobuf.Empty); } Example with streaming methods: service CaldavService { rpc GetCalendar(stream google.api.HttpBody) returns (stream google.api.HttpBody); rpc UpdateCalendar(stream google.api.HttpBody) returns (stream google.api.HttpBody); } Use of this type only changes how the request and response bodies are handled, all other features will continue to work unchanged. # HTTP response with content type set to &quot;application/json+rdap&quot;.
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700[diff] [blame]107 &quot;extensions&quot;: [ # Application specific response metadata. Must be set in the first response for streaming APIs.
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]108 {
109 &quot;a_key&quot;: &quot;&quot;, # Properties of the object. Contains field @type with type URL.
110 },
111 ],
Bu Sun Kim673ec5c2020-11-16 11:05:03 -0700[diff] [blame^]112 &quot;data&quot;: &quot;A String&quot;, # The HTTP request/response body as raw binary.
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]113 &quot;contentType&quot;: &quot;A String&quot;, # The HTTP Content-Type header value specifying the content type of the body.
114 },
Bu Sun Kim673ec5c2020-11-16 11:05:03 -0700[diff] [blame^]115 &quot;lang&quot;: &quot;A String&quot;, # Error language code. Error response info fields are defined in [section 6 of RFC 7483](https://tools.ietf.org/html/rfc7483#section-6).
116 &quot;errorCode&quot;: 42, # Error HTTP code. Example: &quot;501&quot;.
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700[diff] [blame]117 &quot;notices&quot;: [ # Notices applying to this response.
118 { # Notices object defined in [section 4.3 of RFC 7483](https://tools.ietf.org/html/rfc7483#section-4.3).
Bu Sun Kim673ec5c2020-11-16 11:05:03 -0700[diff] [blame^]119 &quot;title&quot;: &quot;A String&quot;, # Title of a notice. Example: &quot;Terms of Service&quot;.
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700[diff] [blame]120 &quot;links&quot;: [ # Link to a document containing more information.
121 { # Links object defined in [section 4.2 of RFC 7483](https://tools.ietf.org/html/rfc7483#section-4.2).
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700[diff] [blame]122 &quot;hreflang&quot;: &quot;A String&quot;, # Language code of a link. Example: &quot;en&quot;.
Bu Sun Kim673ec5c2020-11-16 11:05:03 -0700[diff] [blame^]123 &quot;href&quot;: &quot;A String&quot;, # Target URL of a link. Example: &quot;http://example.com/previous&quot;.
124 &quot;rel&quot;: &quot;A String&quot;, # Relation type of a link. Example: &quot;previous&quot;.
125 &quot;type&quot;: &quot;A String&quot;, # Content type of the link. Example: &quot;application/json&quot;.
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700[diff] [blame]126 &quot;title&quot;: &quot;A String&quot;, # Title of this link. Example: &quot;title&quot;.
127 &quot;value&quot;: &quot;A String&quot;, # URL giving context for the link. Example: &quot;http://example.com/current&quot;.
Bu Sun Kim673ec5c2020-11-16 11:05:03 -0700[diff] [blame^]128 &quot;media&quot;: &quot;A String&quot;, # Media type of the link destination. Example: &quot;screen&quot;.
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700[diff] [blame]129 },
130 ],
131 &quot;description&quot;: [ # Description of the notice.
132 &quot;A String&quot;,
133 ],
134 &quot;type&quot;: &quot;A String&quot;, # Type values defined in [section 10.2.1 of RFC 7483](https://tools.ietf.org/html/rfc7483#section-10.2.1) specific to a whole response: &quot;result set truncated due to authorization&quot;, &quot;result set truncated due to excessive load&quot;, &quot;result set truncated due to unexplainable reasons&quot;.
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700[diff] [blame]135 },
136 ],
Bu Sun Kim673ec5c2020-11-16 11:05:03 -0700[diff] [blame^]137 &quot;description&quot;: [ # Error description.
138 &quot;A String&quot;,
139 ],
140 &quot;rdapConformance&quot;: [ # RDAP conformance level.
141 &quot;A String&quot;,
142 ],
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]143 }</pre>
144</div>
145
146</body></html>