Service Networking API . services . dnsRecordSets

Instance Methods

add(parent, body=None, x__xgafv=None)

Service producers can use this method to add DNS record sets to private DNS

remove(parent, body=None, x__xgafv=None)

Service producers can use this method to remove DNS record sets from

update(parent, body=None, x__xgafv=None)

Service producers can use this method to update DNS record sets from

Method Details

add(parent, body=None, x__xgafv=None)
Service producers can use this method to add DNS record sets to private DNS
zones in the shared producer host project.

Args:
  parent: string, Required. The service that is managing peering connectivity for a service producer's
organization. For Google services that support this functionality, this
value is `services/servicenetworking.googleapis.com`. (required)
  body: object, The request body.
    The object takes the form of:

{ # Request to add a record set to a private managed DNS zone in the shared
      # producer host project.
    "zone": "A String", # Required. The name of the private DNS zone in the shared producer host project to
        # which the record set will be added.
    "consumerNetwork": "A String", # Required. The network that the consumer is using to connect with services.
        # Must be in the form of projects/{project}/global/networks/{network}
        # {project} is the project number, as in '12345'
        # {network} is the network name.
    "dnsRecordSet": { # Represents a DNS record set resource. # Required. The DNS record set to add.
      "data": [ # Required. As defined in RFC 1035 (section 5) and RFC 1034 (section 3.6.1) for
          # examples see https://cloud.google.com/dns/records/json-record.
        "A String",
      ],
      "type": "A String", # Required. The identifier of a supported record type.
      "domain": "A String", # Required. The DNS or domain name of the record set, e.g. `test.example.com`.
      "ttl": "A String", # Required. The period of time for which this RecordSet can be cached by resolvers.
    },
  }

  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.
    "response": { # 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`.
      "a_key": "", # Properties of the object. Contains field @type with type URL.
    },
    "done": 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.
    "error": { # The `Status` type defines a logical error model that is suitable for # The error result of the operation in case of failure or cancellation.
        # 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).
      "code": 42, # The status code, which should be an enum value of google.rpc.Code.
      "details": [ # A list of messages that carry the error details.  There is a common set of
          # message types for APIs to use.
        {
          "a_key": "", # Properties of the object. Contains field @type with type URL.
        },
      ],
      "message": "A String", # 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.
    },
    "name": "A String", # 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}`.
    "metadata": { # 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.
      "a_key": "", # Properties of the object. Contains field @type with type URL.
    },
  }
remove(parent, body=None, x__xgafv=None)
Service producers can use this method to remove DNS record sets from
private DNS zones in the shared producer host project.

Args:
  parent: string, Required. The service that is managing peering connectivity for a service producer's
organization. For Google services that support this functionality, this
value is `services/servicenetworking.googleapis.com`. (required)
  body: object, The request body.
    The object takes the form of:

{ # Request to remove a record set from a private managed DNS zone in the shared
      # producer host project. The name, type, ttl, and data values must all exactly
      # match an existing record set in the specified zone.
    "dnsRecordSet": { # Represents a DNS record set resource. # Required. The DNS record set to remove.
      "data": [ # Required. As defined in RFC 1035 (section 5) and RFC 1034 (section 3.6.1) for
          # examples see https://cloud.google.com/dns/records/json-record.
        "A String",
      ],
      "type": "A String", # Required. The identifier of a supported record type.
      "domain": "A String", # Required. The DNS or domain name of the record set, e.g. `test.example.com`.
      "ttl": "A String", # Required. The period of time for which this RecordSet can be cached by resolvers.
    },
    "consumerNetwork": "A String", # Required. The network that the consumer is using to connect with services.
        # Must be in the form of projects/{project}/global/networks/{network}
        # {project} is the project number, as in '12345'
        # {network} is the network name.
    "zone": "A String", # Required. The name of the private DNS zone in the shared producer host project from
        # which the record set will be removed.
  }

  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.
    "response": { # 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`.
      "a_key": "", # Properties of the object. Contains field @type with type URL.
    },
    "done": 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.
    "error": { # The `Status` type defines a logical error model that is suitable for # The error result of the operation in case of failure or cancellation.
        # 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).
      "code": 42, # The status code, which should be an enum value of google.rpc.Code.
      "details": [ # A list of messages that carry the error details.  There is a common set of
          # message types for APIs to use.
        {
          "a_key": "", # Properties of the object. Contains field @type with type URL.
        },
      ],
      "message": "A String", # 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.
    },
    "name": "A String", # 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}`.
    "metadata": { # 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.
      "a_key": "", # Properties of the object. Contains field @type with type URL.
    },
  }
update(parent, body=None, x__xgafv=None)
Service producers can use this method to update DNS record sets from
private DNS zones in the shared producer host project.

Args:
  parent: string, Required. The service that is managing peering connectivity for a service producer's
organization. For Google services that support this functionality, this
value is `services/servicenetworking.googleapis.com`. (required)
  body: object, The request body.
    The object takes the form of:

{ # Request to update a record set from a private managed DNS zone in the shared
      # producer host project. The name, type, ttl, and data values of the existing
      # record set must all exactly match an existing record set in the specified
      # zone.
    "zone": "A String", # Required. The name of the private DNS zone in the shared producer host project from
        # which the record set will be removed.
    "consumerNetwork": "A String", # Required. The network that the consumer is using to connect with services.
        # Must be in the form of projects/{project}/global/networks/{network}
        # {project} is the project number, as in '12345'
        # {network} is the network name.
    "existingDnsRecordSet": { # Represents a DNS record set resource. # Required. The existing DNS record set to update.
      "data": [ # Required. As defined in RFC 1035 (section 5) and RFC 1034 (section 3.6.1) for
          # examples see https://cloud.google.com/dns/records/json-record.
        "A String",
      ],
      "type": "A String", # Required. The identifier of a supported record type.
      "domain": "A String", # Required. The DNS or domain name of the record set, e.g. `test.example.com`.
      "ttl": "A String", # Required. The period of time for which this RecordSet can be cached by resolvers.
    },
    "newDnsRecordSet": { # Represents a DNS record set resource. # Required. The new values that the DNS record set should be updated to hold.
      "data": [ # Required. As defined in RFC 1035 (section 5) and RFC 1034 (section 3.6.1) for
          # examples see https://cloud.google.com/dns/records/json-record.
        "A String",
      ],
      "type": "A String", # Required. The identifier of a supported record type.
      "domain": "A String", # Required. The DNS or domain name of the record set, e.g. `test.example.com`.
      "ttl": "A String", # Required. The period of time for which this RecordSet can be cached by resolvers.
    },
  }

  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.
    "response": { # 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`.
      "a_key": "", # Properties of the object. Contains field @type with type URL.
    },
    "done": 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.
    "error": { # The `Status` type defines a logical error model that is suitable for # The error result of the operation in case of failure or cancellation.
        # 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).
      "code": 42, # The status code, which should be an enum value of google.rpc.Code.
      "details": [ # A list of messages that carry the error details.  There is a common set of
          # message types for APIs to use.
        {
          "a_key": "", # Properties of the object. Contains field @type with type URL.
        },
      ],
      "message": "A String", # 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.
    },
    "name": "A String", # 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}`.
    "metadata": { # 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.
      "a_key": "", # Properties of the object. Contains field @type with type URL.
    },
  }