blob: 59d24e53a924a0ed8a2d2a4c7e8263b0735902c9 [file] [log] [blame]
<html><body>
<style>
body, h1, h2, h3, div, span, p, pre, a {
margin: 0;
padding: 0;
border: 0;
font-weight: inherit;
font-style: inherit;
font-size: 100%;
font-family: inherit;
vertical-align: baseline;
}
body {
font-size: 13px;
padding: 1em;
}
h1 {
font-size: 26px;
margin-bottom: 1em;
}
h2 {
font-size: 24px;
margin-bottom: 1em;
}
h3 {
font-size: 20px;
margin-bottom: 1em;
margin-top: 1em;
}
pre, code {
line-height: 1.5;
font-family: Monaco, 'DejaVu Sans Mono', 'Bitstream Vera Sans Mono', 'Lucida Console', monospace;
}
pre {
margin-top: 0.5em;
}
h1, h2, h3, p {
font-family: Arial, sans serif;
}
h1, h2, h3 {
border-bottom: solid #CCC 1px;
}
.toc_element {
margin-top: 0.5em;
}
.firstline {
margin-left: 2 em;
}
.method {
margin-top: 1em;
border: solid 1px #CCC;
padding: 1em;
background: #EEE;
}
.details {
font-weight: bold;
font-size: 14px;
}
</style>
<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>
<h2>Instance Methods</h2>
<p class="toc_element">
<code><a href="servicenetworking_v1.services.projects.global_.networks.peeredDnsDomains.html">peeredDnsDomains()</a></code>
</p>
<p class="firstline">Returns the peeredDnsDomains Resource.</p>
<p class="toc_element">
<code><a href="#close">close()</a></code></p>
<p class="firstline">Close httplib2 connections.</p>
<p class="toc_element">
<code><a href="#get">get(name, x__xgafv=None)</a></code></p>
<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>
<p class="toc_element">
<code><a href="#updateConsumerConfig">updateConsumerConfig(parent, body=None, x__xgafv=None)</a></code></p>
<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>
<h3>Method Details</h3>
<div class="method">
<code class="details" id="close">close()</code>
<pre>Close httplib2 connections.</pre>
</div>
<div class="method">
<code class="details" id="get">get(name, x__xgafv=None)</code>
<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.
Args:
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)
x__xgafv: string, V1 error format.
Allowed values
1 - v1 error format
2 - v2 error format
Returns:
An object of the form:
{ # Configuration information for a private service access connection.
&quot;consumerExportCustomRoutes&quot;: True or False, # Export custom routes flag value for peering from consumer to producer.
&quot;consumerExportSubnetRoutesWithPublicIp&quot;: True or False, # Export subnet routes with public ip flag value for peering from consumer to producer.
&quot;consumerImportCustomRoutes&quot;: True or False, # Import custom routes flag value for peering from consumer to producer.
&quot;consumerImportSubnetRoutesWithPublicIp&quot;: True or False, # Import subnet routes with public ip flag value for peering from consumer to producer.
&quot;producerExportCustomRoutes&quot;: True or False, # Export custom routes flag value for peering from producer to consumer.
&quot;producerExportSubnetRoutesWithPublicIp&quot;: True or False, # Export subnet routes with public ip flag value for peering from producer to consumer.
&quot;producerImportCustomRoutes&quot;: True or False, # Import custom routes flag value for peering from producer to consumer.
&quot;producerImportSubnetRoutesWithPublicIp&quot;: True or False, # Import subnet routes with public ip flag value for peering from producer to consumer.
&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.
&quot;reservedRanges&quot;: [ # Output only. The reserved ranges associated with this private service access connection.
{ # Allocated IP address ranges for this private service access connection.
&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.
&quot;ipPrefixLength&quot;: 42, # The prefix length of the reserved range.
&quot;name&quot;: &quot;A String&quot;, # The name of the reserved range.
},
],
&quot;vpcScReferenceArchitectureEnabled&quot;: True or False, # Output only. Indicates whether the VPC Service Controls reference architecture is configured for the producer VPC host network.
}</pre>
</div>
<div class="method">
<code class="details" id="updateConsumerConfig">updateConsumerConfig(parent, body=None, x__xgafv=None)</code>
<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.
Args:
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)
body: object, The request body.
The object takes the form of:
{ # Request to update the configuration of a service networking connection including the import/export of custom routes and subnetwork routes with public IP.
&quot;consumerConfig&quot;: { # Configuration information for a private service access connection. # Required. The updated peering config.
&quot;consumerExportCustomRoutes&quot;: True or False, # Export custom routes flag value for peering from consumer to producer.
&quot;consumerExportSubnetRoutesWithPublicIp&quot;: True or False, # Export subnet routes with public ip flag value for peering from consumer to producer.
&quot;consumerImportCustomRoutes&quot;: True or False, # Import custom routes flag value for peering from consumer to producer.
&quot;consumerImportSubnetRoutesWithPublicIp&quot;: True or False, # Import subnet routes with public ip flag value for peering from consumer to producer.
&quot;producerExportCustomRoutes&quot;: True or False, # Export custom routes flag value for peering from producer to consumer.
&quot;producerExportSubnetRoutesWithPublicIp&quot;: True or False, # Export subnet routes with public ip flag value for peering from producer to consumer.
&quot;producerImportCustomRoutes&quot;: True or False, # Import custom routes flag value for peering from producer to consumer.
&quot;producerImportSubnetRoutesWithPublicIp&quot;: True or False, # Import subnet routes with public ip flag value for peering from producer to consumer.
&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.
&quot;reservedRanges&quot;: [ # Output only. The reserved ranges associated with this private service access connection.
{ # Allocated IP address ranges for this private service access connection.
&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.
&quot;ipPrefixLength&quot;: 42, # The prefix length of the reserved range.
&quot;name&quot;: &quot;A String&quot;, # The name of the reserved range.
},
],
&quot;vpcScReferenceArchitectureEnabled&quot;: True or False, # Output only. Indicates whether the VPC Service Controls reference architecture is configured for the producer VPC host network.
},
}
x__xgafv: string, V1 error format.
Allowed values
1 - v1 error format
2 - v2 error format
Returns:
An object of the form:
{ # This resource represents a long-running operation that is the result of a network API call.
&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.
&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.
&quot;code&quot;: 42, # The status code, which should be an enum value of google.rpc.Code.
&quot;details&quot;: [ # A list of messages that carry the error details. There is a common set of message types for APIs to use.
{
&quot;a_key&quot;: &quot;&quot;, # Properties of the object. Contains field @type with type URL.
},
],
&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.
},
&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.
&quot;a_key&quot;: &quot;&quot;, # Properties of the object. Contains field @type with type URL.
},
&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}`.
&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`.
&quot;a_key&quot;: &quot;&quot;, # Properties of the object. Contains field @type with type URL.
},
}</pre>
</div>
</body></html>