# Datastream API . projects . locations . privateConnections

## Instance Methods

Returns the routes Resource.

Close httplib2 connections.

Use this method to create a private connectivity configuration.

Use this method to delete a private connectivity configuration.

Use this method to get details about a private connectivity configuration.

Use this method to list private connectivity configurations in a project and location.

Retrieves the next page of results.

### Method Details

`close()`

    Close httplib2 connections.

`create(parent, body=None, privateConnectionId=None, requestId=None, x__xgafv=None)`

    Use this method to create a private connectivity configuration.

    Args:
      parent: string, Required. The parent that owns the collection of PrivateConnections. (required)
      body: object, The request body.
        The object takes the form of:

    { # The PrivateConnection resource is used to establish private connectivity between Datastream and a customer's network.
      "createTime": "A String", # Output only. The create time of the resource.
      "displayName": "A String", # Required. Display name.
      "error": { # Represent a user-facing Error. # Output only. In case of error, the details of the error in a user-friendly format.
        "details": { # Additional information about the error.
          "a_key": "A String",
        },
        "errorTime": "A String", # The time when the error occurred.
        "errorUuid": "A String", # A unique identifier for this specific error, allowing it to be traced throughout the system in logs and API responses.
        "message": "A String", # A message containing more information about the error that occurred.
        "reason": "A String", # A title that explains the reason for the error.
      },
      "labels": { # Labels.
        "a_key": "A String",
      },
      "name": "A String", # Output only. The resource's name.
      "state": "A String", # Output only. The state of the Private Connection.
      "updateTime": "A String", # Output only. The update time of the resource.
      "vpcPeeringConfig": { # The VPC Peering configuration is used to create VPC peering between Datastream and the consumer's VPC. # VPC Peering Config
        "subnet": "A String", # Required. A free subnet for peering. (CIDR of /29) TODO(b/172995841) add validators.
        "vpcName": "A String", # Required. fully qualified name of the VPC Datastream will peer to.
      },
    }

      privateConnectionId: string, Required. The private connectivity identifier.
      requestId: string, Optional. A request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. The server will guarantee that for at least 60 minutes since the first request. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000).
      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 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.
      },
    }

`delete(name, force=None, requestId=None, x__xgafv=None)`

    Use this method to delete a private connectivity configuration.

    Args:
      name: string, Required. The name of the private connectivity configuration to delete. (required)
      force: boolean, Optional. If set to true, any child routes that belong to this PrivateConnection will also be deleted.
      requestId: string, Optional. A request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. The server will guarantee that for at least 60 minutes after the first request. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000).
      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 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.
      },
    }

`get(name, x__xgafv=None)`

    Use this method to get details about a private connectivity configuration.

    Args:
      name: string, Required. The name of the private connectivity configuration to get. (required)
      x__xgafv: string, V1 error format.
        Allowed values
          1 - v1 error format
          2 - v2 error format

    Returns:
      An object of the form:

        { # The PrivateConnection resource is used to establish private connectivity between Datastream and a customer's network.
      "createTime": "A String", # Output only. The create time of the resource.
      "displayName": "A String", # Required. Display name.
      "error": { # Represent a user-facing Error. # Output only. In case of error, the details of the error in a user-friendly format.
        "details": { # Additional information about the error.
          "a_key": "A String",
        },
        "errorTime": "A String", # The time when the error occurred.
        "errorUuid": "A String", # A unique identifier for this specific error, allowing it to be traced throughout the system in logs and API responses.
        "message": "A String", # A message containing more information about the error that occurred.
        "reason": "A String", # A title that explains the reason for the error.
      },
      "labels": { # Labels.
        "a_key": "A String",
      },
      "name": "A String", # Output only. The resource's name.
      "state": "A String", # Output only. The state of the Private Connection.
      "updateTime": "A String", # Output only. The update time of the resource.
      "vpcPeeringConfig": { # The VPC Peering configuration is used to create VPC peering between Datastream and the consumer's VPC. # VPC Peering Config
        "subnet": "A String", # Required. A free subnet for peering. (CIDR of /29) TODO(b/172995841) add validators.
        "vpcName": "A String", # Required. fully qualified name of the VPC Datastream will peer to.
      },
    }

`list(parent, filter=None, orderBy=None, pageSize=None, pageToken=None, x__xgafv=None)`

    Use this method to list private connectivity configurations in a project and location.

    Args:
      parent: string, Required. The parent that owns the collection of private connectivity configurations. (required)
      filter: string, Filter request.
      orderBy: string, Order by fields for the result.
      pageSize: integer, Maximum number of private connectivity configurations to return. If unspecified, at most 50 private connectivity configurations that will be returned. The maximum value is 1000; values above 1000 will be coerced to 1000.
      pageToken: string, Page token received from a previous `ListPrivateConnections` call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to `ListPrivateConnections` must match the call that provided the page token.
      x__xgafv: string, V1 error format.
        Allowed values
          1 - v1 error format
          2 - v2 error format

    Returns:
      An object of the form:

        {
      "nextPageToken": "A String", # A token, which can be sent as `page_token` to retrieve the next page. If this field is omitted, there are no subsequent pages.
      "privateConnections": [ # List of private connectivity configurations.
        { # The PrivateConnection resource is used to establish private connectivity between Datastream and a customer's network.
          "createTime": "A String", # Output only. The create time of the resource.
          "displayName": "A String", # Required. Display name.
          "error": { # Represent a user-facing Error. # Output only. In case of error, the details of the error in a user-friendly format.
            "details": { # Additional information about the error.
              "a_key": "A String",
            },
            "errorTime": "A String", # The time when the error occurred.
            "errorUuid": "A String", # A unique identifier for this specific error, allowing it to be traced throughout the system in logs and API responses.
            "message": "A String", # A message containing more information about the error that occurred.
            "reason": "A String", # A title that explains the reason for the error.
          },
          "labels": { # Labels.
            "a_key": "A String",
          },
          "name": "A String", # Output only. The resource's name.
          "state": "A String", # Output only. The state of the Private Connection.
          "updateTime": "A String", # Output only. The update time of the resource.
          "vpcPeeringConfig": { # The VPC Peering configuration is used to create VPC peering between Datastream and the consumer's VPC. # VPC Peering Config
            "subnet": "A String", # Required. A free subnet for peering. (CIDR of /29) TODO(b/172995841) add validators.
            "vpcName": "A String", # Required. fully qualified name of the VPC Datastream will peer to.
          },
        },
      ],
      "unreachable": [ # Locations that could not be reached.
        "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.