Serverless VPC Access API . projects . locations . connectors

Instance Methods

close()

Close httplib2 connections.

create(parent, body=None, connectorId=None, x__xgafv=None)

Creates a Serverless VPC Access connector, returns an operation.

delete(name, x__xgafv=None)

Deletes a Serverless VPC Access connector. Returns NOT_FOUND if the resource does not exist.

get(name, x__xgafv=None)

Gets a Serverless VPC Access connector. Returns NOT_FOUND if the resource does not exist.

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

Lists Serverless VPC Access connectors.

list_next()

Retrieves the next page of results.

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

Updates a Serverless VPC Access connector, returns an operation.

Method Details

close()
Close httplib2 connections.
create(parent, body=None, connectorId=None, x__xgafv=None)
Creates a Serverless VPC Access connector, returns an operation.

Args:
  parent: string, Required. The project ID and location in which the configuration should be created, specified in the format `projects/*/locations/*`. (required)
  body: object, The request body.
    The object takes the form of:

{ # Definition of a Serverless VPC Access connector.
  "connectedProjects": [ # Output only. List of projects using the connector.
    "A String",
  ],
  "createTime": "A String", # Output only. The creation time of the connector.
  "ipCidrRange": "A String", # Optional. The range of internal addresses that follows RFC 4632 notation. Example: `10.132.0.0/28`.
  "lastRestartTime": "A String", # Output only. The last restart time of the connector.
  "machineType": "A String", # Machine type of VM Instance underlying connector. Default is e2-micro
  "maxInstances": 42, # Maximum value of instances in autoscaling group underlying the connector.
  "maxThroughput": 42, # Maximum throughput of the connector in Mbps. Refers to the expected throughput when using an `e2-micro` machine type. Value must be a multiple of 100 from 300 through 1000. Must be higher than the value specified by --min-throughput. If both max-throughput and max-instances are provided, max-instances takes precedence over max-throughput. The use of `max-throughput` is discouraged in favor of `max-instances`.
  "minInstances": 42, # Minimum value of instances in autoscaling group underlying the connector.
  "minThroughput": 42, # Minimum throughput of the connector in Mbps. Refers to the expected throughput when using an `e2-micro` machine type. Value must be a multiple of 100 from 200 through 900. Must be lower than the value specified by --max-throughput. If both min-throughput and min-instances are provided, min-instances takes precedence over min-throughput. The use of `min-throughput` is discouraged in favor of `min-instances`.
  "name": "A String", # The resource name in the format `projects/*/locations/*/connectors/*`.
  "network": "A String", # Optional. Name of a VPC network.
  "state": "A String", # Output only. State of the VPC access connector.
  "subnet": { # The subnet in which to house the connector # Optional. The subnet in which to house the VPC Access Connector.
    "name": "A String", # Optional. Subnet name (relative, not fully qualified). E.g. if the full subnet selfLink is https://compute.googleapis.com/compute/v1/projects/{project}/regions/{region}/subnetworks/{subnetName} the correct input for this field would be {subnetName}
    "projectId": "A String", # Optional. Project in which the subnet exists. If not set, this project is assumed to be the project for which the connector create request was issued.
  },
}

  connectorId: string, Required. The ID to use for this connector.
  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, x__xgafv=None)
Deletes a Serverless VPC Access connector. Returns NOT_FOUND if the resource does not exist.

Args:
  name: string, Required. Name of a Serverless VPC Access connector to delete. (required)
  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, x__xgafv=None)
Gets a Serverless VPC Access connector. Returns NOT_FOUND if the resource does not exist.

Args:
  name: string, Required. Name of a Serverless VPC Access connector 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:

    { # Definition of a Serverless VPC Access connector.
  "connectedProjects": [ # Output only. List of projects using the connector.
    "A String",
  ],
  "createTime": "A String", # Output only. The creation time of the connector.
  "ipCidrRange": "A String", # Optional. The range of internal addresses that follows RFC 4632 notation. Example: `10.132.0.0/28`.
  "lastRestartTime": "A String", # Output only. The last restart time of the connector.
  "machineType": "A String", # Machine type of VM Instance underlying connector. Default is e2-micro
  "maxInstances": 42, # Maximum value of instances in autoscaling group underlying the connector.
  "maxThroughput": 42, # Maximum throughput of the connector in Mbps. Refers to the expected throughput when using an `e2-micro` machine type. Value must be a multiple of 100 from 300 through 1000. Must be higher than the value specified by --min-throughput. If both max-throughput and max-instances are provided, max-instances takes precedence over max-throughput. The use of `max-throughput` is discouraged in favor of `max-instances`.
  "minInstances": 42, # Minimum value of instances in autoscaling group underlying the connector.
  "minThroughput": 42, # Minimum throughput of the connector in Mbps. Refers to the expected throughput when using an `e2-micro` machine type. Value must be a multiple of 100 from 200 through 900. Must be lower than the value specified by --max-throughput. If both min-throughput and min-instances are provided, min-instances takes precedence over min-throughput. The use of `min-throughput` is discouraged in favor of `min-instances`.
  "name": "A String", # The resource name in the format `projects/*/locations/*/connectors/*`.
  "network": "A String", # Optional. Name of a VPC network.
  "state": "A String", # Output only. State of the VPC access connector.
  "subnet": { # The subnet in which to house the connector # Optional. The subnet in which to house the VPC Access Connector.
    "name": "A String", # Optional. Subnet name (relative, not fully qualified). E.g. if the full subnet selfLink is https://compute.googleapis.com/compute/v1/projects/{project}/regions/{region}/subnetworks/{subnetName} the correct input for this field would be {subnetName}
    "projectId": "A String", # Optional. Project in which the subnet exists. If not set, this project is assumed to be the project for which the connector create request was issued.
  },
}
list(parent, pageSize=None, pageToken=None, x__xgafv=None)
Lists Serverless VPC Access connectors.

Args:
  parent: string, Required. The project and location from which the routes should be listed. (required)
  pageSize: integer, Maximum number of functions to return per call.
  pageToken: string, Continuation token.
  x__xgafv: string, V1 error format.
    Allowed values
      1 - v1 error format
      2 - v2 error format

Returns:
  An object of the form:

    { # Response for listing Serverless VPC Access connectors.
  "connectors": [ # List of Serverless VPC Access connectors.
    { # Definition of a Serverless VPC Access connector.
      "connectedProjects": [ # Output only. List of projects using the connector.
        "A String",
      ],
      "createTime": "A String", # Output only. The creation time of the connector.
      "ipCidrRange": "A String", # Optional. The range of internal addresses that follows RFC 4632 notation. Example: `10.132.0.0/28`.
      "lastRestartTime": "A String", # Output only. The last restart time of the connector.
      "machineType": "A String", # Machine type of VM Instance underlying connector. Default is e2-micro
      "maxInstances": 42, # Maximum value of instances in autoscaling group underlying the connector.
      "maxThroughput": 42, # Maximum throughput of the connector in Mbps. Refers to the expected throughput when using an `e2-micro` machine type. Value must be a multiple of 100 from 300 through 1000. Must be higher than the value specified by --min-throughput. If both max-throughput and max-instances are provided, max-instances takes precedence over max-throughput. The use of `max-throughput` is discouraged in favor of `max-instances`.
      "minInstances": 42, # Minimum value of instances in autoscaling group underlying the connector.
      "minThroughput": 42, # Minimum throughput of the connector in Mbps. Refers to the expected throughput when using an `e2-micro` machine type. Value must be a multiple of 100 from 200 through 900. Must be lower than the value specified by --max-throughput. If both min-throughput and min-instances are provided, min-instances takes precedence over min-throughput. The use of `min-throughput` is discouraged in favor of `min-instances`.
      "name": "A String", # The resource name in the format `projects/*/locations/*/connectors/*`.
      "network": "A String", # Optional. Name of a VPC network.
      "state": "A String", # Output only. State of the VPC access connector.
      "subnet": { # The subnet in which to house the connector # Optional. The subnet in which to house the VPC Access Connector.
        "name": "A String", # Optional. Subnet name (relative, not fully qualified). E.g. if the full subnet selfLink is https://compute.googleapis.com/compute/v1/projects/{project}/regions/{region}/subnetworks/{subnetName} the correct input for this field would be {subnetName}
        "projectId": "A String", # Optional. Project in which the subnet exists. If not set, this project is assumed to be the project for which the connector create request was issued.
      },
    },
  ],
  "nextPageToken": "A String", # Continuation token.
}
list_next()
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, updateMask=None, x__xgafv=None)
Updates a Serverless VPC Access connector, returns an operation.

Args:
  name: string, The resource name in the format `projects/*/locations/*/connectors/*`. (required)
  body: object, The request body.
    The object takes the form of:

{ # Definition of a Serverless VPC Access connector.
  "connectedProjects": [ # Output only. List of projects using the connector.
    "A String",
  ],
  "createTime": "A String", # Output only. The creation time of the connector.
  "ipCidrRange": "A String", # Optional. The range of internal addresses that follows RFC 4632 notation. Example: `10.132.0.0/28`.
  "lastRestartTime": "A String", # Output only. The last restart time of the connector.
  "machineType": "A String", # Machine type of VM Instance underlying connector. Default is e2-micro
  "maxInstances": 42, # Maximum value of instances in autoscaling group underlying the connector.
  "maxThroughput": 42, # Maximum throughput of the connector in Mbps. Refers to the expected throughput when using an `e2-micro` machine type. Value must be a multiple of 100 from 300 through 1000. Must be higher than the value specified by --min-throughput. If both max-throughput and max-instances are provided, max-instances takes precedence over max-throughput. The use of `max-throughput` is discouraged in favor of `max-instances`.
  "minInstances": 42, # Minimum value of instances in autoscaling group underlying the connector.
  "minThroughput": 42, # Minimum throughput of the connector in Mbps. Refers to the expected throughput when using an `e2-micro` machine type. Value must be a multiple of 100 from 200 through 900. Must be lower than the value specified by --max-throughput. If both min-throughput and min-instances are provided, min-instances takes precedence over min-throughput. The use of `min-throughput` is discouraged in favor of `min-instances`.
  "name": "A String", # The resource name in the format `projects/*/locations/*/connectors/*`.
  "network": "A String", # Optional. Name of a VPC network.
  "state": "A String", # Output only. State of the VPC access connector.
  "subnet": { # The subnet in which to house the connector # Optional. The subnet in which to house the VPC Access Connector.
    "name": "A String", # Optional. Subnet name (relative, not fully qualified). E.g. if the full subnet selfLink is https://compute.googleapis.com/compute/v1/projects/{project}/regions/{region}/subnetworks/{subnetName} the correct input for this field would be {subnetName}
    "projectId": "A String", # Optional. Project in which the subnet exists. If not set, this project is assumed to be the project for which the connector create request was issued.
  },
}

  updateMask: string, The fields to update on the entry group. If absent or empty, all modifiable fields are 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.
  },
}