• Home
  • Line#
  • Scopes#
  • Navigate#
  • Raw
  • Download
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="servicenetworking_v1.html">Service Networking API</a> . <a href="servicenetworking_v1.services.html">services</a> . <a href="servicenetworking_v1.services.projects.html">projects</a> . <a href="servicenetworking_v1.services.projects.global_.html">global_</a> . <a href="servicenetworking_v1.services.projects.global_.networks.html">networks</a> . <a href="servicenetworking_v1.services.projects.global_.networks.peeredDnsDomains.html">peeredDnsDomains</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 peered DNS domain which sends requests for records in given namespace originating in the service producer VPC network to the consumer VPC network to be resolved.</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 peered DNS domain.</p>
86<p class="toc_element">
87  <code><a href="#list">list(parent, x__xgafv=None)</a></code></p>
88<p class="firstline">Lists peered DNS domains for a connection.</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 peered DNS domain which sends requests for records in given namespace originating in the service producer VPC network to the consumer VPC network to be resolved.
98
99Args:
100  parent: string, Required. Parent resource identifying the connection for which the peered DNS domain will be created in the format: `services/{service}/projects/{project}/global/networks/{network}` {service} is the peering service that is managing connectivity for the service producer&#x27;s organization. For Google services that support this functionality, this value is `servicenetworking.googleapis.com`. {project} is the number of the project that contains the service consumer&#x27;s VPC network e.g. `12345`. {network} is the name of the service consumer&#x27;s VPC network. (required)
101  body: object, The request body.
102    The object takes the form of:
103
104{ # DNS domain suffix for which requests originating in the producer VPC network are resolved in the associated consumer VPC network.
105  &quot;dnsSuffix&quot;: &quot;A String&quot;, # The DNS domain name suffix e.g. `example.com.`. Cloud DNS requires that a DNS suffix ends with a trailing dot.
106  &quot;name&quot;: &quot;A String&quot;, # User assigned name for this resource. Must be unique within the consumer network. The name must be 1-63 characters long, must begin with a letter, end with a letter or digit, and only contain lowercase letters, digits or dashes.
107}
108
109  x__xgafv: string, V1 error format.
110    Allowed values
111      1 - v1 error format
112      2 - v2 error format
113
114Returns:
115  An object of the form:
116
117    { # This resource represents a long-running operation that is the result of a network API call.
118  &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.
119  &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.
120    &quot;code&quot;: 42, # The status code, which should be an enum value of google.rpc.Code.
121    &quot;details&quot;: [ # A list of messages that carry the error details. There is a common set of message types for APIs to use.
122      {
123        &quot;a_key&quot;: &quot;&quot;, # Properties of the object. Contains field @type with type URL.
124      },
125    ],
126    &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.
127  },
128  &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.
129    &quot;a_key&quot;: &quot;&quot;, # Properties of the object. Contains field @type with type URL.
130  },
131  &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}`.
132  &quot;response&quot;: { # The normal response of the operation in case of success. 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`.
133    &quot;a_key&quot;: &quot;&quot;, # Properties of the object. Contains field @type with type URL.
134  },
135}</pre>
136</div>
137
138<div class="method">
139    <code class="details" id="delete">delete(name, x__xgafv=None)</code>
140  <pre>Deletes a peered DNS domain.
141
142Args:
143  name: string, Required. The name of the peered DNS domain to delete in the format: `services/{service}/projects/{project}/global/networks/{network}/peeredDnsDomains/{name}`. {service} is the peering service that is managing connectivity for the service producer&#x27;s organization. For Google services that support this functionality, this value is `servicenetworking.googleapis.com`. {project} is the number of the project that contains the service consumer&#x27;s VPC network e.g. `12345`. {network} is the name of the service consumer&#x27;s VPC network. {name} is the name of the peered DNS domain. (required)
144  x__xgafv: string, V1 error format.
145    Allowed values
146      1 - v1 error format
147      2 - v2 error format
148
149Returns:
150  An object of the form:
151
152    { # This resource represents a long-running operation that is the result of a network API call.
153  &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.
154  &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.
155    &quot;code&quot;: 42, # The status code, which should be an enum value of google.rpc.Code.
156    &quot;details&quot;: [ # A list of messages that carry the error details. There is a common set of message types for APIs to use.
157      {
158        &quot;a_key&quot;: &quot;&quot;, # Properties of the object. Contains field @type with type URL.
159      },
160    ],
161    &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.
162  },
163  &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.
164    &quot;a_key&quot;: &quot;&quot;, # Properties of the object. Contains field @type with type URL.
165  },
166  &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}`.
167  &quot;response&quot;: { # The normal response of the operation in case of success. 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`.
168    &quot;a_key&quot;: &quot;&quot;, # Properties of the object. Contains field @type with type URL.
169  },
170}</pre>
171</div>
172
173<div class="method">
174    <code class="details" id="list">list(parent, x__xgafv=None)</code>
175  <pre>Lists peered DNS domains for a connection.
176
177Args:
178  parent: string, Required. Parent resource identifying the connection which owns this collection of peered DNS domains in the format: `services/{service}/projects/{project}/global/networks/{network}`. {service} is the peering service that is managing connectivity for the service producer&#x27;s organization. For Google services that support this functionality, this value is `servicenetworking.googleapis.com`. {project} is a project number e.g. `12345` that contains the service consumer&#x27;s VPC network. {network} is the name of the service consumer&#x27;s VPC network. (required)
179  x__xgafv: string, V1 error format.
180    Allowed values
181      1 - v1 error format
182      2 - v2 error format
183
184Returns:
185  An object of the form:
186
187    { # Response to list peered DNS domains for a given connection.
188  &quot;peeredDnsDomains&quot;: [ # The list of peered DNS domains.
189    { # DNS domain suffix for which requests originating in the producer VPC network are resolved in the associated consumer VPC network.
190      &quot;dnsSuffix&quot;: &quot;A String&quot;, # The DNS domain name suffix e.g. `example.com.`. Cloud DNS requires that a DNS suffix ends with a trailing dot.
191      &quot;name&quot;: &quot;A String&quot;, # User assigned name for this resource. Must be unique within the consumer network. The name must be 1-63 characters long, must begin with a letter, end with a letter or digit, and only contain lowercase letters, digits or dashes.
192    },
193  ],
194}</pre>
195</div>
196
197</body></html>