• 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></h1>
76<h2>Instance Methods</h2>
77<p class="toc_element">
78  <code><a href="servicenetworking_v1.services.projects.global_.networks.peeredDnsDomains.html">peeredDnsDomains()</a></code>
79</p>
80<p class="firstline">Returns the peeredDnsDomains Resource.</p>
81
82<p class="toc_element">
83  <code><a href="#close">close()</a></code></p>
84<p class="firstline">Close httplib2 connections.</p>
85<p class="toc_element">
86  <code><a href="#get">get(name, x__xgafv=None)</a></code></p>
87<p class="firstline">Service producers use this method to get the configuration of their connection including the import/export of custom routes and subnetwork routes with public IP.</p>
88<p class="toc_element">
89  <code><a href="#updateConsumerConfig">updateConsumerConfig(parent, body=None, x__xgafv=None)</a></code></p>
90<p class="firstline">Service producers use this method to update the configuration of their connection including the import/export of custom routes and subnetwork routes with public IP.</p>
91<h3>Method Details</h3>
92<div class="method">
93    <code class="details" id="close">close()</code>
94  <pre>Close httplib2 connections.</pre>
95</div>
96
97<div class="method">
98    <code class="details" id="get">get(name, x__xgafv=None)</code>
99  <pre>Service producers use this method to get the configuration of their connection including the import/export of custom routes and subnetwork routes with public IP.
100
101Args:
102  name: string, Required. Name of the consumer config to retrieve 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)
103  x__xgafv: string, V1 error format.
104    Allowed values
105      1 - v1 error format
106      2 - v2 error format
107
108Returns:
109  An object of the form:
110
111    { # Configuration information for a private service access connection.
112  &quot;consumerExportCustomRoutes&quot;: True or False, # Export custom routes flag value for peering from consumer to producer.
113  &quot;consumerExportSubnetRoutesWithPublicIp&quot;: True or False, # Export subnet routes with public ip flag value for peering from consumer to producer.
114  &quot;consumerImportCustomRoutes&quot;: True or False, # Import custom routes flag value for peering from consumer to producer.
115  &quot;consumerImportSubnetRoutesWithPublicIp&quot;: True or False, # Import subnet routes with public ip flag value for peering from consumer to producer.
116  &quot;producerExportCustomRoutes&quot;: True or False, # Export custom routes flag value for peering from producer to consumer.
117  &quot;producerExportSubnetRoutesWithPublicIp&quot;: True or False, # Export subnet routes with public ip flag value for peering from producer to consumer.
118  &quot;producerImportCustomRoutes&quot;: True or False, # Import custom routes flag value for peering from producer to consumer.
119  &quot;producerImportSubnetRoutesWithPublicIp&quot;: True or False, # Import subnet routes with public ip flag value for peering from producer to consumer.
120  &quot;producerNetwork&quot;: &quot;A String&quot;, # Output only. The VPC host network that is used to host managed service instances. In the format, projects/{project}/global/networks/{network} where {project} is the project number e.g. &#x27;12345&#x27; and {network} is the network name.
121  &quot;reservedRanges&quot;: [ # Output only. The reserved ranges associated with this private service access connection.
122    { # Allocated IP address ranges for this private service access connection.
123      &quot;address&quot;: &quot;A String&quot;, # The starting address of the reserved range. The address must be a valid IPv4 address in the x.x.x.x format. This value combined with the IP prefix length is the CIDR range for the reserved range.
124      &quot;ipPrefixLength&quot;: 42, # The prefix length of the reserved range.
125      &quot;name&quot;: &quot;A String&quot;, # The name of the reserved range.
126    },
127  ],
128  &quot;vpcScReferenceArchitectureEnabled&quot;: True or False, # Output only. Indicates whether the VPC Service Controls reference architecture is configured for the producer VPC host network.
129}</pre>
130</div>
131
132<div class="method">
133    <code class="details" id="updateConsumerConfig">updateConsumerConfig(parent, body=None, x__xgafv=None)</code>
134  <pre>Service producers use this method to update the configuration of their connection including the import/export of custom routes and subnetwork routes with public IP.
135
136Args:
137  parent: string, Required. Parent resource identifying the connection for which the consumer config is being updated 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)
138  body: object, The request body.
139    The object takes the form of:
140
141{ # Request to update the configuration of a service networking connection including the import/export of custom routes and subnetwork routes with public IP.
142  &quot;consumerConfig&quot;: { # Configuration information for a private service access connection. # Required. The updated peering config.
143    &quot;consumerExportCustomRoutes&quot;: True or False, # Export custom routes flag value for peering from consumer to producer.
144    &quot;consumerExportSubnetRoutesWithPublicIp&quot;: True or False, # Export subnet routes with public ip flag value for peering from consumer to producer.
145    &quot;consumerImportCustomRoutes&quot;: True or False, # Import custom routes flag value for peering from consumer to producer.
146    &quot;consumerImportSubnetRoutesWithPublicIp&quot;: True or False, # Import subnet routes with public ip flag value for peering from consumer to producer.
147    &quot;producerExportCustomRoutes&quot;: True or False, # Export custom routes flag value for peering from producer to consumer.
148    &quot;producerExportSubnetRoutesWithPublicIp&quot;: True or False, # Export subnet routes with public ip flag value for peering from producer to consumer.
149    &quot;producerImportCustomRoutes&quot;: True or False, # Import custom routes flag value for peering from producer to consumer.
150    &quot;producerImportSubnetRoutesWithPublicIp&quot;: True or False, # Import subnet routes with public ip flag value for peering from producer to consumer.
151    &quot;producerNetwork&quot;: &quot;A String&quot;, # Output only. The VPC host network that is used to host managed service instances. In the format, projects/{project}/global/networks/{network} where {project} is the project number e.g. &#x27;12345&#x27; and {network} is the network name.
152    &quot;reservedRanges&quot;: [ # Output only. The reserved ranges associated with this private service access connection.
153      { # Allocated IP address ranges for this private service access connection.
154        &quot;address&quot;: &quot;A String&quot;, # The starting address of the reserved range. The address must be a valid IPv4 address in the x.x.x.x format. This value combined with the IP prefix length is the CIDR range for the reserved range.
155        &quot;ipPrefixLength&quot;: 42, # The prefix length of the reserved range.
156        &quot;name&quot;: &quot;A String&quot;, # The name of the reserved range.
157      },
158    ],
159    &quot;vpcScReferenceArchitectureEnabled&quot;: True or False, # Output only. Indicates whether the VPC Service Controls reference architecture is configured for the producer VPC host network.
160  },
161}
162
163  x__xgafv: string, V1 error format.
164    Allowed values
165      1 - v1 error format
166      2 - v2 error format
167
168Returns:
169  An object of the form:
170
171    { # This resource represents a long-running operation that is the result of a network API call.
172  &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.
173  &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.
174    &quot;code&quot;: 42, # The status code, which should be an enum value of google.rpc.Code.
175    &quot;details&quot;: [ # A list of messages that carry the error details. There is a common set of message types for APIs to use.
176      {
177        &quot;a_key&quot;: &quot;&quot;, # Properties of the object. Contains field @type with type URL.
178      },
179    ],
180    &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.
181  },
182  &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.
183    &quot;a_key&quot;: &quot;&quot;, # Properties of the object. Contains field @type with type URL.
184  },
185  &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}`.
186  &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`.
187    &quot;a_key&quot;: &quot;&quot;, # Properties of the object. Contains field @type with type URL.
188  },
189}</pre>
190</div>
191
192</body></html>