Cloud DNS API . outboundEndpoints

close()

Close httplib2 connections.

create(parent, body=None, clientOperationId=None, outboundEndpointId=None, requestId=None, x__xgafv=None)

Creates a new Outbound Endpoint.

Args:
  parent: string, Required. The parent project and location where this OutboundEndpoint will be created. Format: projects/{project}/locations/{location} (required)
  body: object, The request body.
    The object takes the form of:

{ # An OutboundEndpoint is a regional resource to enable outbound forwarding from a private IP range in VPCs to on-premise or other networks.
  "annotations": { # Optional. Annotations as key value pairs
    "a_key": "A String",
  },
  "createTime": "A String", # Output only. [Output only] Create time stamp
  "description": "A String", # Optional. User provided description.
  "endpointIp": "A String", # Optional. Immutable. User provided IP address to use for outbound DNS forwarding. This address must be a free address on the subnetwork. If omitted, a free IP address from the subnetwork is automatically allocated.
  "labels": { # Optional. Labels as key value pairs
    "a_key": "A String",
  },
  "name": "A String", # Identifier. The resource name of the OutboundEndpoint. Format: `projects/{project}/locations/{location}/outboundEndpoints/{outboundEndpoint}`
  "network": "A String", # Required. Immutable. The VPC network containing the outbound endpoint, specified as full path.
  "subnetwork": "A String", # Required. Immutable. The subnetwork holding the endpoint_ip, specified as full path.
  "tags": { # Optional. Tag bindings as key value pairs
    "a_key": "A String",
  },
  "updateTime": "A String", # Output only. [Output only] Update time stamp
}

  clientOperationId: string, For mutating operation requests only. An optional identifier specified by the client. Must be unique for operation resources in the Operations collection.
  outboundEndpointId: string, Required. The ID to use for the OutboundEndpoint, which will become the final component of the OutboundEndpoint's resource name.
  requestId: string, Optional. An optional request ID to identify requests.
  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.
  "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 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.
    "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.
  },
  "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.
  },
  "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}`.
  "response": { # The normal, successful response of the operation. 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.
  },
}

delete(name, clientOperationId=None, requestId=None, x__xgafv=None)

Deletes a previously created Outbound Endpoint.

Args:
  name: string, Required. The name of the OutboundEndpoint to delete. Format: projects/{project}/locations/{location}/outboundEndpoints/{outboundEndpoint} (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.
  requestId: string, Optional. An optional request ID to identify requests.
  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.
  "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 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.
    "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.
  },
  "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.
  },
  "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}`.
  "response": { # The normal, successful response of the operation. 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.
  },
}

get(name, clientOperationId=None, x__xgafv=None)

Fetches the representation of an existing Outbound Endpoint.

Args:
  name: string, Required. The name of the OutboundEndpoint to retrieve. Format: projects/{project}/locations/{location}/outboundEndpoints/{outboundEndpoint} (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:

    { # An OutboundEndpoint is a regional resource to enable outbound forwarding from a private IP range in VPCs to on-premise or other networks.
  "annotations": { # Optional. Annotations as key value pairs
    "a_key": "A String",
  },
  "createTime": "A String", # Output only. [Output only] Create time stamp
  "description": "A String", # Optional. User provided description.
  "endpointIp": "A String", # Optional. Immutable. User provided IP address to use for outbound DNS forwarding. This address must be a free address on the subnetwork. If omitted, a free IP address from the subnetwork is automatically allocated.
  "labels": { # Optional. Labels as key value pairs
    "a_key": "A String",
  },
  "name": "A String", # Identifier. The resource name of the OutboundEndpoint. Format: `projects/{project}/locations/{location}/outboundEndpoints/{outboundEndpoint}`
  "network": "A String", # Required. Immutable. The VPC network containing the outbound endpoint, specified as full path.
  "subnetwork": "A String", # Required. Immutable. The subnetwork holding the endpoint_ip, specified as full path.
  "tags": { # Optional. Tag bindings as key value pairs
    "a_key": "A String",
  },
  "updateTime": "A String", # Output only. [Output only] Update time stamp
}

list(parent, clientOperationId=None, pageSize=None, pageToken=None, x__xgafv=None)

Enumerates all Outbound Endpoints associated with a project.

Args:
  parent: string, Required. The parent project and location from which to list resources. Format: projects/{project}/locations/{location} (required)
  clientOperationId: string, A parameter
  pageSize: integer, Optional. The maximum number of results to return.
  pageToken: string, Optional. A page token received from a previous List call.
  x__xgafv: string, V1 error format.
    Allowed values
      1 - v1 error format
      2 - v2 error format

Returns:
  An object of the form:

    { # Response message for OutboundEndpointsService.ListOutboundEndpoints
  "nextPageToken": "A String", # A token to retrieve the next page of results. Set to empty if there are no remaining results.
  "outboundEndpoints": [ # The list of OutboundEndpoints.
    { # An OutboundEndpoint is a regional resource to enable outbound forwarding from a private IP range in VPCs to on-premise or other networks.
      "annotations": { # Optional. Annotations as key value pairs
        "a_key": "A String",
      },
      "createTime": "A String", # Output only. [Output only] Create time stamp
      "description": "A String", # Optional. User provided description.
      "endpointIp": "A String", # Optional. Immutable. User provided IP address to use for outbound DNS forwarding. This address must be a free address on the subnetwork. If omitted, a free IP address from the subnetwork is automatically allocated.
      "labels": { # Optional. Labels as key value pairs
        "a_key": "A String",
      },
      "name": "A String", # Identifier. The resource name of the OutboundEndpoint. Format: `projects/{project}/locations/{location}/outboundEndpoints/{outboundEndpoint}`
      "network": "A String", # Required. Immutable. The VPC network containing the outbound endpoint, specified as full path.
      "subnetwork": "A String", # Required. Immutable. The subnetwork holding the endpoint_ip, specified as full path.
      "tags": { # Optional. Tag bindings as key value pairs
        "a_key": "A String",
      },
      "updateTime": "A String", # Output only. [Output only] Update time stamp
    },
  ],
  "unreachable": [ # Unordered list. The resource names of the unreachable locations. Format: `projects/{project}/locations/{location}`
    "A String",
  ],
}

list_next(previous_request, previous_response)

Retrieves the next page of results.

Args:
  previous_request: The request for the previous page. (required)
  previous_response: The response from the request for the previous page. (required)

Returns:
  A request object that you can call 'execute()' on to request the next
  page. Returns None if there are no more items in the collection.

patch(name, body=None, clientOperationId=None, requestId=None, updateMask=None, x__xgafv=None)

Updates an existing Outbound Endpoint.

Args:
  name: string, Identifier. The resource name of the OutboundEndpoint. Format: `projects/{project}/locations/{location}/outboundEndpoints/{outboundEndpoint}` (required)
  body: object, The request body.
    The object takes the form of:

{ # An OutboundEndpoint is a regional resource to enable outbound forwarding from a private IP range in VPCs to on-premise or other networks.
  "annotations": { # Optional. Annotations as key value pairs
    "a_key": "A String",
  },
  "createTime": "A String", # Output only. [Output only] Create time stamp
  "description": "A String", # Optional. User provided description.
  "endpointIp": "A String", # Optional. Immutable. User provided IP address to use for outbound DNS forwarding. This address must be a free address on the subnetwork. If omitted, a free IP address from the subnetwork is automatically allocated.
  "labels": { # Optional. Labels as key value pairs
    "a_key": "A String",
  },
  "name": "A String", # Identifier. The resource name of the OutboundEndpoint. Format: `projects/{project}/locations/{location}/outboundEndpoints/{outboundEndpoint}`
  "network": "A String", # Required. Immutable. The VPC network containing the outbound endpoint, specified as full path.
  "subnetwork": "A String", # Required. Immutable. The subnetwork holding the endpoint_ip, specified as full path.
  "tags": { # Optional. Tag bindings as key value pairs
    "a_key": "A String",
  },
  "updateTime": "A String", # Output only. [Output only] Update time stamp
}

  clientOperationId: string, For mutating operation requests only. An optional identifier specified by the client. Must be unique for operation resources in the Operations collection.
  requestId: string, Optional. An optional request ID to identify requests.
  updateMask: string, Required. The list of fields to be updated.
  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.
  "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 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.
    "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.
  },
  "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.
  },
  "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}`.
  "response": { # The normal, successful response of the operation. 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.
  },
}