blob: 2d43b684ef99a7a09e51889d480f58e3a2de4fc1 [file] [log] [blame]
Bu Sun Kim65020912020-05-20 12:08:20 -07001<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.entity.html">entity</a></h1>
76<h2>Instance Methods</h2>
77<p class="toc_element">
Dmitry Frenkel3e17f892020-10-06 16:46:05 -070078 <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 -070081 <code><a href="#get">get(entityId, x__xgafv=None)</a></code></p>
Dmitry Frenkel3e17f892020-10-06 16:46:05 -070082<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 -070083<h3>Method Details</h3>
84<div class="method">
Dmitry Frenkel3e17f892020-10-06 16:46:05 -070085 <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 -070090 <code class="details" id="get">get(entityId, x__xgafv=None)</code>
Dmitry Frenkel3e17f892020-10-06 16:46:05 -070091 <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 -070092
93Args:
94 entityId: string, A parameter (required)
95 x__xgafv: string, V1 error format.
96 Allowed values
97 1 - v1 error format
98 2 - v2 error format
99
100Returns:
101 An object of the form:
102
103 { # Response to a general RDAP query.
Yoshi Automation Botcc94ec82021-01-15 07:10:04 -0800104 &quot;description&quot;: [ # Error description.
105 &quot;A String&quot;,
106 ],
107 &quot;errorCode&quot;: 42, # Error HTTP code. Example: &quot;501&quot;.
108 &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;.
109 &quot;contentType&quot;: &quot;A String&quot;, # The HTTP Content-Type header value specifying the content type of the body.
110 &quot;data&quot;: &quot;A String&quot;, # The HTTP request/response body as raw binary.
111 &quot;extensions&quot;: [ # Application specific response metadata. Must be set in the first response for streaming APIs.
112 {
113 &quot;a_key&quot;: &quot;&quot;, # Properties of the object. Contains field @type with type URL.
Yoshi Automation Botc2228be2020-11-24 15:48:03 -0800114 },
115 ],
Yoshi Automation Botcc94ec82021-01-15 07:10:04 -0800116 },
117 &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).
118 &quot;notices&quot;: [ # Notices applying to this response.
119 { # Notices object defined in [section 4.3 of RFC 7483](https://tools.ietf.org/html/rfc7483#section-4.3).
120 &quot;description&quot;: [ # Description of the notice.
121 &quot;A String&quot;,
122 ],
123 &quot;links&quot;: [ # Link to a document containing more information.
124 { # Links object defined in [section 4.2 of RFC 7483](https://tools.ietf.org/html/rfc7483#section-4.2).
125 &quot;href&quot;: &quot;A String&quot;, # Target URL of a link. Example: &quot;http://example.com/previous&quot;.
126 &quot;hreflang&quot;: &quot;A String&quot;, # Language code of a link. Example: &quot;en&quot;.
127 &quot;media&quot;: &quot;A String&quot;, # Media type of the link destination. Example: &quot;screen&quot;.
128 &quot;rel&quot;: &quot;A String&quot;, # Relation type of a link. Example: &quot;previous&quot;.
129 &quot;title&quot;: &quot;A String&quot;, # Title of this link. Example: &quot;title&quot;.
130 &quot;type&quot;: &quot;A String&quot;, # Content type of the link. Example: &quot;application/json&quot;.
131 &quot;value&quot;: &quot;A String&quot;, # URL giving context for the link. Example: &quot;http://example.com/current&quot;.
132 },
133 ],
134 &quot;title&quot;: &quot;A String&quot;, # Title of a notice. Example: &quot;Terms of Service&quot;.
135 &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;.
136 },
137 ],
138 &quot;rdapConformance&quot;: [ # RDAP conformance level.
139 &quot;A String&quot;,
140 ],
141 &quot;title&quot;: &quot;A String&quot;, # Error title.
142}</pre>
Bu Sun Kim65020912020-05-20 12:08:20 -0700143</div>
144
145</body></html>