| <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="dns_v1beta2.html">Cloud DNS API</a> . <a href="dns_v1beta2.projects.html">projects</a> . <a href="dns_v1beta2.projects.managedZones.html">managedZones</a> . <a href="dns_v1beta2.projects.managedZones.rrsets.html">rrsets</a></h1> |
| <h2>Instance Methods</h2> |
| <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="#create">create(project, managedZone, body=None, clientOperationId=None, x__xgafv=None)</a></code></p> |
| <p class="firstline">Create a new ResourceRecordSet.</p> |
| <p class="toc_element"> |
| <code><a href="#delete">delete(project, managedZone, name, type, clientOperationId=None, x__xgafv=None)</a></code></p> |
| <p class="firstline">Delete a previously created ResourceRecordSet.</p> |
| <p class="toc_element"> |
| <code><a href="#get">get(project, managedZone, name, type, clientOperationId=None, x__xgafv=None)</a></code></p> |
| <p class="firstline">Fetch the representation of an existing ResourceRecordSet.</p> |
| <p class="toc_element"> |
| <code><a href="#patch">patch(project, managedZone, name, type, body=None, clientOperationId=None, x__xgafv=None)</a></code></p> |
| <p class="firstline">Apply a partial update to an existing ResourceRecordSet.</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="create">create(project, managedZone, body=None, clientOperationId=None, x__xgafv=None)</code> |
| <pre>Create a new ResourceRecordSet. |
| |
| Args: |
| project: string, Identifies the project addressed by this request. (required) |
| managedZone: string, Identifies the managed zone addressed by this request. Can be the managed zone name or ID. (required) |
| body: object, The request body. |
| The object takes the form of: |
| |
| { # A unit of data that will be returned by the DNS servers. |
| "name": "A String", # For example, www.example.com. |
| "rrdatas": [ # As defined in RFC 1035 (section 5) and RFC 1034 (section 3.6.1) -- see examples. |
| "A String", |
| ], |
| "signatureRrdatas": [ # As defined in RFC 4034 (section 3.2). |
| "A String", |
| ], |
| "ttl": 42, # Number of seconds that this ResourceRecordSet can be cached by resolvers. |
| "routingPolicy": { # A RRSetRoutingPolicy represents ResourceRecordSet data that will be returned dynamically with the response varying based on configured properties such as geolocation or by weighted random selection. # Configures dynamic query responses based on geo location of querying user or a weighted round robin based routing policy. A ResourceRecordSet should only have either rrdata (static) or routing_policy(dynamic). An error is returned otherwise. |
| "geoPolicy": { |
| "failovers": [ # If the health check for the primary target for a geo location returns an unhealthy status, the failover target is returned instead. This failover configuration is not mandatory. If a failover is not provided, the primary target won't be healthchecked - we'll return the primarily configured rrdata irrespective of whether it is healthy or not. |
| { |
| "rrdatas": [ |
| "A String", |
| ], |
| "kind": "dns#rRSetRoutingPolicyGeoPolicyGeoPolicyItem", |
| "location": "A String", # The geo-location granularity is a GCP region. This location string should correspond to a GCP region. e.g "us-east1", "southamerica-east1", "asia-east1", etc. |
| "signatureRrdatas": [ # DNSSEC generated signatures for the above geo_rrdata. |
| "A String", |
| ], |
| }, |
| ], |
| "items": [ # The primary geo routing configuration. If there are multiple items with the same location, an error is returned instead. |
| { |
| "rrdatas": [ |
| "A String", |
| ], |
| "kind": "dns#rRSetRoutingPolicyGeoPolicyGeoPolicyItem", |
| "location": "A String", # The geo-location granularity is a GCP region. This location string should correspond to a GCP region. e.g "us-east1", "southamerica-east1", "asia-east1", etc. |
| "signatureRrdatas": [ # DNSSEC generated signatures for the above geo_rrdata. |
| "A String", |
| ], |
| }, |
| ], |
| "kind": "dns#rRSetRoutingPolicyGeoPolicy", |
| }, |
| "kind": "dns#rRSetRoutingPolicy", |
| "wrrPolicy": { |
| "kind": "dns#rRSetRoutingPolicyWrrPolicy", |
| "items": [ |
| { |
| "signatureRrdatas": [ # DNSSEC generated signatures for the above wrr_rrdata. |
| "A String", |
| ], |
| "rrdatas": [ |
| "A String", |
| ], |
| "kind": "dns#rRSetRoutingPolicyWrrPolicyWrrPolicyItem", |
| "weight": 3.14, # The weight corresponding to this subset of rrdata. When multiple WeightedRoundRobinPolicyItems are configured, the probability of returning an rrset is proportional to its weight relative to the sum of weights configured for all items. This weight should be a decimal in the range [0,1]. |
| }, |
| ], |
| }, |
| }, |
| "kind": "dns#resourceRecordSet", |
| "type": "A String", # The identifier of a supported record type. See the list of Supported DNS record types. |
| } |
| |
| clientOperationId: string, For mutating operation requests only. An optional identifier specified by the client. Must be unique for operation resources in the Operations collection. |
| x__xgafv: string, V1 error format. |
| Allowed values |
| 1 - v1 error format |
| 2 - v2 error format |
| |
| Returns: |
| An object of the form: |
| |
| { # A unit of data that will be returned by the DNS servers. |
| "name": "A String", # For example, www.example.com. |
| "rrdatas": [ # As defined in RFC 1035 (section 5) and RFC 1034 (section 3.6.1) -- see examples. |
| "A String", |
| ], |
| "signatureRrdatas": [ # As defined in RFC 4034 (section 3.2). |
| "A String", |
| ], |
| "ttl": 42, # Number of seconds that this ResourceRecordSet can be cached by resolvers. |
| "routingPolicy": { # A RRSetRoutingPolicy represents ResourceRecordSet data that will be returned dynamically with the response varying based on configured properties such as geolocation or by weighted random selection. # Configures dynamic query responses based on geo location of querying user or a weighted round robin based routing policy. A ResourceRecordSet should only have either rrdata (static) or routing_policy(dynamic). An error is returned otherwise. |
| "geoPolicy": { |
| "failovers": [ # If the health check for the primary target for a geo location returns an unhealthy status, the failover target is returned instead. This failover configuration is not mandatory. If a failover is not provided, the primary target won't be healthchecked - we'll return the primarily configured rrdata irrespective of whether it is healthy or not. |
| { |
| "rrdatas": [ |
| "A String", |
| ], |
| "kind": "dns#rRSetRoutingPolicyGeoPolicyGeoPolicyItem", |
| "location": "A String", # The geo-location granularity is a GCP region. This location string should correspond to a GCP region. e.g "us-east1", "southamerica-east1", "asia-east1", etc. |
| "signatureRrdatas": [ # DNSSEC generated signatures for the above geo_rrdata. |
| "A String", |
| ], |
| }, |
| ], |
| "items": [ # The primary geo routing configuration. If there are multiple items with the same location, an error is returned instead. |
| { |
| "rrdatas": [ |
| "A String", |
| ], |
| "kind": "dns#rRSetRoutingPolicyGeoPolicyGeoPolicyItem", |
| "location": "A String", # The geo-location granularity is a GCP region. This location string should correspond to a GCP region. e.g "us-east1", "southamerica-east1", "asia-east1", etc. |
| "signatureRrdatas": [ # DNSSEC generated signatures for the above geo_rrdata. |
| "A String", |
| ], |
| }, |
| ], |
| "kind": "dns#rRSetRoutingPolicyGeoPolicy", |
| }, |
| "kind": "dns#rRSetRoutingPolicy", |
| "wrrPolicy": { |
| "kind": "dns#rRSetRoutingPolicyWrrPolicy", |
| "items": [ |
| { |
| "signatureRrdatas": [ # DNSSEC generated signatures for the above wrr_rrdata. |
| "A String", |
| ], |
| "rrdatas": [ |
| "A String", |
| ], |
| "kind": "dns#rRSetRoutingPolicyWrrPolicyWrrPolicyItem", |
| "weight": 3.14, # The weight corresponding to this subset of rrdata. When multiple WeightedRoundRobinPolicyItems are configured, the probability of returning an rrset is proportional to its weight relative to the sum of weights configured for all items. This weight should be a decimal in the range [0,1]. |
| }, |
| ], |
| }, |
| }, |
| "kind": "dns#resourceRecordSet", |
| "type": "A String", # The identifier of a supported record type. See the list of Supported DNS record types. |
| }</pre> |
| </div> |
| |
| <div class="method"> |
| <code class="details" id="delete">delete(project, managedZone, name, type, clientOperationId=None, x__xgafv=None)</code> |
| <pre>Delete a previously created ResourceRecordSet. |
| |
| Args: |
| project: string, Identifies the project addressed by this request. (required) |
| managedZone: string, Identifies the managed zone addressed by this request. Can be the managed zone name or ID. (required) |
| name: string, Fully qualified domain name. (required) |
| type: string, RRSet type. (required) |
| clientOperationId: string, For mutating operation requests only. An optional identifier specified by the client. Must be unique for operation resources in the Operations collection. |
| x__xgafv: string, V1 error format. |
| Allowed values |
| 1 - v1 error format |
| 2 - v2 error format |
| |
| Returns: |
| An object of the form: |
| |
| { |
| }</pre> |
| </div> |
| |
| <div class="method"> |
| <code class="details" id="get">get(project, managedZone, name, type, clientOperationId=None, x__xgafv=None)</code> |
| <pre>Fetch the representation of an existing ResourceRecordSet. |
| |
| Args: |
| project: string, Identifies the project addressed by this request. (required) |
| managedZone: string, Identifies the managed zone addressed by this request. Can be the managed zone name or ID. (required) |
| name: string, Fully qualified domain name. (required) |
| type: string, RRSet type. (required) |
| clientOperationId: string, For mutating operation requests only. An optional identifier specified by the client. Must be unique for operation resources in the Operations collection. |
| x__xgafv: string, V1 error format. |
| Allowed values |
| 1 - v1 error format |
| 2 - v2 error format |
| |
| Returns: |
| An object of the form: |
| |
| { # A unit of data that will be returned by the DNS servers. |
| "name": "A String", # For example, www.example.com. |
| "rrdatas": [ # As defined in RFC 1035 (section 5) and RFC 1034 (section 3.6.1) -- see examples. |
| "A String", |
| ], |
| "signatureRrdatas": [ # As defined in RFC 4034 (section 3.2). |
| "A String", |
| ], |
| "ttl": 42, # Number of seconds that this ResourceRecordSet can be cached by resolvers. |
| "routingPolicy": { # A RRSetRoutingPolicy represents ResourceRecordSet data that will be returned dynamically with the response varying based on configured properties such as geolocation or by weighted random selection. # Configures dynamic query responses based on geo location of querying user or a weighted round robin based routing policy. A ResourceRecordSet should only have either rrdata (static) or routing_policy(dynamic). An error is returned otherwise. |
| "geoPolicy": { |
| "failovers": [ # If the health check for the primary target for a geo location returns an unhealthy status, the failover target is returned instead. This failover configuration is not mandatory. If a failover is not provided, the primary target won't be healthchecked - we'll return the primarily configured rrdata irrespective of whether it is healthy or not. |
| { |
| "rrdatas": [ |
| "A String", |
| ], |
| "kind": "dns#rRSetRoutingPolicyGeoPolicyGeoPolicyItem", |
| "location": "A String", # The geo-location granularity is a GCP region. This location string should correspond to a GCP region. e.g "us-east1", "southamerica-east1", "asia-east1", etc. |
| "signatureRrdatas": [ # DNSSEC generated signatures for the above geo_rrdata. |
| "A String", |
| ], |
| }, |
| ], |
| "items": [ # The primary geo routing configuration. If there are multiple items with the same location, an error is returned instead. |
| { |
| "rrdatas": [ |
| "A String", |
| ], |
| "kind": "dns#rRSetRoutingPolicyGeoPolicyGeoPolicyItem", |
| "location": "A String", # The geo-location granularity is a GCP region. This location string should correspond to a GCP region. e.g "us-east1", "southamerica-east1", "asia-east1", etc. |
| "signatureRrdatas": [ # DNSSEC generated signatures for the above geo_rrdata. |
| "A String", |
| ], |
| }, |
| ], |
| "kind": "dns#rRSetRoutingPolicyGeoPolicy", |
| }, |
| "kind": "dns#rRSetRoutingPolicy", |
| "wrrPolicy": { |
| "kind": "dns#rRSetRoutingPolicyWrrPolicy", |
| "items": [ |
| { |
| "signatureRrdatas": [ # DNSSEC generated signatures for the above wrr_rrdata. |
| "A String", |
| ], |
| "rrdatas": [ |
| "A String", |
| ], |
| "kind": "dns#rRSetRoutingPolicyWrrPolicyWrrPolicyItem", |
| "weight": 3.14, # The weight corresponding to this subset of rrdata. When multiple WeightedRoundRobinPolicyItems are configured, the probability of returning an rrset is proportional to its weight relative to the sum of weights configured for all items. This weight should be a decimal in the range [0,1]. |
| }, |
| ], |
| }, |
| }, |
| "kind": "dns#resourceRecordSet", |
| "type": "A String", # The identifier of a supported record type. See the list of Supported DNS record types. |
| }</pre> |
| </div> |
| |
| <div class="method"> |
| <code class="details" id="patch">patch(project, managedZone, name, type, body=None, clientOperationId=None, x__xgafv=None)</code> |
| <pre>Apply a partial update to an existing ResourceRecordSet. |
| |
| Args: |
| project: string, Identifies the project addressed by this request. (required) |
| managedZone: string, Identifies the managed zone addressed by this request. Can be the managed zone name or ID. (required) |
| name: string, Fully qualified domain name. (required) |
| type: string, RRSet type. (required) |
| body: object, The request body. |
| The object takes the form of: |
| |
| { # A unit of data that will be returned by the DNS servers. |
| "name": "A String", # For example, www.example.com. |
| "rrdatas": [ # As defined in RFC 1035 (section 5) and RFC 1034 (section 3.6.1) -- see examples. |
| "A String", |
| ], |
| "signatureRrdatas": [ # As defined in RFC 4034 (section 3.2). |
| "A String", |
| ], |
| "ttl": 42, # Number of seconds that this ResourceRecordSet can be cached by resolvers. |
| "routingPolicy": { # A RRSetRoutingPolicy represents ResourceRecordSet data that will be returned dynamically with the response varying based on configured properties such as geolocation or by weighted random selection. # Configures dynamic query responses based on geo location of querying user or a weighted round robin based routing policy. A ResourceRecordSet should only have either rrdata (static) or routing_policy(dynamic). An error is returned otherwise. |
| "geoPolicy": { |
| "failovers": [ # If the health check for the primary target for a geo location returns an unhealthy status, the failover target is returned instead. This failover configuration is not mandatory. If a failover is not provided, the primary target won't be healthchecked - we'll return the primarily configured rrdata irrespective of whether it is healthy or not. |
| { |
| "rrdatas": [ |
| "A String", |
| ], |
| "kind": "dns#rRSetRoutingPolicyGeoPolicyGeoPolicyItem", |
| "location": "A String", # The geo-location granularity is a GCP region. This location string should correspond to a GCP region. e.g "us-east1", "southamerica-east1", "asia-east1", etc. |
| "signatureRrdatas": [ # DNSSEC generated signatures for the above geo_rrdata. |
| "A String", |
| ], |
| }, |
| ], |
| "items": [ # The primary geo routing configuration. If there are multiple items with the same location, an error is returned instead. |
| { |
| "rrdatas": [ |
| "A String", |
| ], |
| "kind": "dns#rRSetRoutingPolicyGeoPolicyGeoPolicyItem", |
| "location": "A String", # The geo-location granularity is a GCP region. This location string should correspond to a GCP region. e.g "us-east1", "southamerica-east1", "asia-east1", etc. |
| "signatureRrdatas": [ # DNSSEC generated signatures for the above geo_rrdata. |
| "A String", |
| ], |
| }, |
| ], |
| "kind": "dns#rRSetRoutingPolicyGeoPolicy", |
| }, |
| "kind": "dns#rRSetRoutingPolicy", |
| "wrrPolicy": { |
| "kind": "dns#rRSetRoutingPolicyWrrPolicy", |
| "items": [ |
| { |
| "signatureRrdatas": [ # DNSSEC generated signatures for the above wrr_rrdata. |
| "A String", |
| ], |
| "rrdatas": [ |
| "A String", |
| ], |
| "kind": "dns#rRSetRoutingPolicyWrrPolicyWrrPolicyItem", |
| "weight": 3.14, # The weight corresponding to this subset of rrdata. When multiple WeightedRoundRobinPolicyItems are configured, the probability of returning an rrset is proportional to its weight relative to the sum of weights configured for all items. This weight should be a decimal in the range [0,1]. |
| }, |
| ], |
| }, |
| }, |
| "kind": "dns#resourceRecordSet", |
| "type": "A String", # The identifier of a supported record type. See the list of Supported DNS record types. |
| } |
| |
| clientOperationId: string, For mutating operation requests only. An optional identifier specified by the client. Must be unique for operation resources in the Operations collection. |
| x__xgafv: string, V1 error format. |
| Allowed values |
| 1 - v1 error format |
| 2 - v2 error format |
| |
| Returns: |
| An object of the form: |
| |
| { # A unit of data that will be returned by the DNS servers. |
| "name": "A String", # For example, www.example.com. |
| "rrdatas": [ # As defined in RFC 1035 (section 5) and RFC 1034 (section 3.6.1) -- see examples. |
| "A String", |
| ], |
| "signatureRrdatas": [ # As defined in RFC 4034 (section 3.2). |
| "A String", |
| ], |
| "ttl": 42, # Number of seconds that this ResourceRecordSet can be cached by resolvers. |
| "routingPolicy": { # A RRSetRoutingPolicy represents ResourceRecordSet data that will be returned dynamically with the response varying based on configured properties such as geolocation or by weighted random selection. # Configures dynamic query responses based on geo location of querying user or a weighted round robin based routing policy. A ResourceRecordSet should only have either rrdata (static) or routing_policy(dynamic). An error is returned otherwise. |
| "geoPolicy": { |
| "failovers": [ # If the health check for the primary target for a geo location returns an unhealthy status, the failover target is returned instead. This failover configuration is not mandatory. If a failover is not provided, the primary target won't be healthchecked - we'll return the primarily configured rrdata irrespective of whether it is healthy or not. |
| { |
| "rrdatas": [ |
| "A String", |
| ], |
| "kind": "dns#rRSetRoutingPolicyGeoPolicyGeoPolicyItem", |
| "location": "A String", # The geo-location granularity is a GCP region. This location string should correspond to a GCP region. e.g "us-east1", "southamerica-east1", "asia-east1", etc. |
| "signatureRrdatas": [ # DNSSEC generated signatures for the above geo_rrdata. |
| "A String", |
| ], |
| }, |
| ], |
| "items": [ # The primary geo routing configuration. If there are multiple items with the same location, an error is returned instead. |
| { |
| "rrdatas": [ |
| "A String", |
| ], |
| "kind": "dns#rRSetRoutingPolicyGeoPolicyGeoPolicyItem", |
| "location": "A String", # The geo-location granularity is a GCP region. This location string should correspond to a GCP region. e.g "us-east1", "southamerica-east1", "asia-east1", etc. |
| "signatureRrdatas": [ # DNSSEC generated signatures for the above geo_rrdata. |
| "A String", |
| ], |
| }, |
| ], |
| "kind": "dns#rRSetRoutingPolicyGeoPolicy", |
| }, |
| "kind": "dns#rRSetRoutingPolicy", |
| "wrrPolicy": { |
| "kind": "dns#rRSetRoutingPolicyWrrPolicy", |
| "items": [ |
| { |
| "signatureRrdatas": [ # DNSSEC generated signatures for the above wrr_rrdata. |
| "A String", |
| ], |
| "rrdatas": [ |
| "A String", |
| ], |
| "kind": "dns#rRSetRoutingPolicyWrrPolicyWrrPolicyItem", |
| "weight": 3.14, # The weight corresponding to this subset of rrdata. When multiple WeightedRoundRobinPolicyItems are configured, the probability of returning an rrset is proportional to its weight relative to the sum of weights configured for all items. This weight should be a decimal in the range [0,1]. |
| }, |
| ], |
| }, |
| }, |
| "kind": "dns#resourceRecordSet", |
| "type": "A String", # The identifier of a supported record type. See the list of Supported DNS record types. |
| }</pre> |
| </div> |
| |
| </body></html> |