BeyondCorp API . projects . locations . securityGateways

Instance Methods

applications()

Returns the applications Resource.

close()

Close httplib2 connections.

create(parent, body=None, requestId=None, securityGatewayId=None, x__xgafv=None)

Creates a new SecurityGateway in a given project and location.

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

Deletes a single SecurityGateway.

get(name, x__xgafv=None)

Gets details of a single SecurityGateway.

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

Lists SecurityGateways in a given project and location.

list_next()

Retrieves the next page of results.

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

Updates the parameters of a single SecurityGateway.

setPeering(securityGateway, body=None, x__xgafv=None)

This is a custom method to allow customers to create a peering connections between Google network and customer networks. This is enabled only for the allowlisted customers.

Method Details

close()
Close httplib2 connections.
create(parent, body=None, requestId=None, securityGatewayId=None, x__xgafv=None)
Creates a new SecurityGateway in a given project and location.

Args:
  parent: string, Required. The resource project name of the SecurityGateway location using the form: `projects/{project_id}/locations/{location_id}` (required)
  body: object, The request body.
    The object takes the form of:

{ # Information about a BeyoncCorp SecurityGateway resource.
  "createTime": "A String", # Output only. Timestamp when the resource was created.
  "displayName": "A String", # Optional. An arbitrary user-provided name for the SecurityGateway. Cannot exceed 64 characters.
  "externalIps": [ # Output only. IP addresses that will be used for establishing connection to the endpoints.
    "A String",
  ],
  "hubs": { # Optional. Map of Hubs that represents regional data path deployment with GCP region as a key.
    "a_key": { # The Hub message contains information pertaining to the regional data path deployments.
      "internetGateway": { # Represents the Internet Gateway configuration. # Optional. Internet Gateway configuration.
        "assignedIps": [ # Output only. List of IP addresses assigned to the Cloud NAT.
          "A String",
        ],
      },
    },
  },
  "name": "A String", # Identifier. Name of the resource.
  "state": "A String", # Output only. The operational state of the SecurityGateway.
  "updateTime": "A String", # Output only. Timestamp when the resource was last modified.
}

  requestId: string, Optional. An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore request if it has already been completed. The server will guarantee that for at least 60 minutes since the first request.
  securityGatewayId: string, Optional. User-settable SecurityGateway resource ID. * Must start with a letter. * Must contain between 4-63 characters from `/a-z-/`. * Must end with a number or letter.
  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, requestId=None, validateOnly=None, x__xgafv=None)
Deletes a single SecurityGateway.

Args:
  name: string, Required. BeyondCorp SecurityGateway name using the form: `projects/{project_id}/locations/{location_id}/securityGateways/{security_gateway_id}` (required)
  requestId: string, Optional. An optional 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).
  validateOnly: boolean, Optional. If set, validates request by executing a dry-run which would not alter the resource in any way.
  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 details of a single SecurityGateway.

Args:
  name: string, Required. The resource name of the PartnerTenant using the form: `projects/{project_id}/locations/{location_id}/securityGateway/{security_gateway_id}` (required)
  x__xgafv: string, V1 error format.
    Allowed values
      1 - v1 error format
      2 - v2 error format

Returns:
  An object of the form:

    { # Information about a BeyoncCorp SecurityGateway resource.
  "createTime": "A String", # Output only. Timestamp when the resource was created.
  "displayName": "A String", # Optional. An arbitrary user-provided name for the SecurityGateway. Cannot exceed 64 characters.
  "externalIps": [ # Output only. IP addresses that will be used for establishing connection to the endpoints.
    "A String",
  ],
  "hubs": { # Optional. Map of Hubs that represents regional data path deployment with GCP region as a key.
    "a_key": { # The Hub message contains information pertaining to the regional data path deployments.
      "internetGateway": { # Represents the Internet Gateway configuration. # Optional. Internet Gateway configuration.
        "assignedIps": [ # Output only. List of IP addresses assigned to the Cloud NAT.
          "A String",
        ],
      },
    },
  },
  "name": "A String", # Identifier. Name of the resource.
  "state": "A String", # Output only. The operational state of the SecurityGateway.
  "updateTime": "A String", # Output only. Timestamp when the resource was last modified.
}
list(parent, filter=None, orderBy=None, pageSize=None, pageToken=None, x__xgafv=None)
Lists SecurityGateways in a given project and location.

Args:
  parent: string, Required. The parent location to which the resources belong. `projects/{project_id}/locations/{location_id}/` (required)
  filter: string, Optional. A filter specifying constraints of a list operation. All fields in the SecurityGateway message are supported. For example, the following query will return the SecurityGateway with displayName "test-security-gateway" For more information, please refer to https://google.aip.dev/160.
  orderBy: string, Optional. Specifies the ordering of results. See [Sorting order](https://cloud.google.com/apis/design/design_patterns#sorting_order) for more information.
  pageSize: integer, Optional. The maximum number of items to return. If not specified, a default value of 50 will be used by the service. Regardless of the page_size value, the response may include a partial list and a caller should only rely on response's next_page_token to determine if there are more instances left to be queried.
  pageToken: string, Optional. The next_page_token value returned from a previous ListSecurityGatewayRequest, if any.
  x__xgafv: string, V1 error format.
    Allowed values
      1 - v1 error format
      2 - v2 error format

Returns:
  An object of the form:

    { # Message for response to listing SecurityGateways.
  "nextPageToken": "A String", # A token to retrieve the next page of results, or empty if there are no more results in the list.
  "securityGateways": [ # A list of BeyondCorp SecurityGateway in the project.
    { # Information about a BeyoncCorp SecurityGateway resource.
      "createTime": "A String", # Output only. Timestamp when the resource was created.
      "displayName": "A String", # Optional. An arbitrary user-provided name for the SecurityGateway. Cannot exceed 64 characters.
      "externalIps": [ # Output only. IP addresses that will be used for establishing connection to the endpoints.
        "A String",
      ],
      "hubs": { # Optional. Map of Hubs that represents regional data path deployment with GCP region as a key.
        "a_key": { # The Hub message contains information pertaining to the regional data path deployments.
          "internetGateway": { # Represents the Internet Gateway configuration. # Optional. Internet Gateway configuration.
            "assignedIps": [ # Output only. List of IP addresses assigned to the Cloud NAT.
              "A String",
            ],
          },
        },
      },
      "name": "A String", # Identifier. Name of the resource.
      "state": "A String", # Output only. The operational state of the SecurityGateway.
      "updateTime": "A String", # Output only. Timestamp when the resource was last modified.
    },
  ],
  "unreachable": [ # A list of locations that could not be reached.
    "A String",
  ],
}
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, requestId=None, updateMask=None, x__xgafv=None)
Updates the parameters of a single SecurityGateway.

Args:
  name: string, Identifier. Name of the resource. (required)
  body: object, The request body.
    The object takes the form of:

{ # Information about a BeyoncCorp SecurityGateway resource.
  "createTime": "A String", # Output only. Timestamp when the resource was created.
  "displayName": "A String", # Optional. An arbitrary user-provided name for the SecurityGateway. Cannot exceed 64 characters.
  "externalIps": [ # Output only. IP addresses that will be used for establishing connection to the endpoints.
    "A String",
  ],
  "hubs": { # Optional. Map of Hubs that represents regional data path deployment with GCP region as a key.
    "a_key": { # The Hub message contains information pertaining to the regional data path deployments.
      "internetGateway": { # Represents the Internet Gateway configuration. # Optional. Internet Gateway configuration.
        "assignedIps": [ # Output only. List of IP addresses assigned to the Cloud NAT.
          "A String",
        ],
      },
    },
  },
  "name": "A String", # Identifier. Name of the resource.
  "state": "A String", # Output only. The operational state of the SecurityGateway.
  "updateTime": "A String", # Output only. Timestamp when the resource was last modified.
}

  requestId: string, Optional. An optional 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 timed 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).
  updateMask: string, Required. Mutable fields include: display_name, hubs.
  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.
  },
}
setPeering(securityGateway, body=None, x__xgafv=None)
This is a custom method to allow customers to create a peering connections between Google network and customer networks. This is enabled only for the allowlisted customers.

Args:
  securityGateway: string, Required. BeyondCorp SecurityGateway name using the form: `projects/{project}/locations/{location}/securityGateways/{security_gateway}` (required)
  body: object, The request body.
    The object takes the form of:

{ # Set Peering request for creating a VPC peering between Google network and customer networks.
  "peerings": [ # Required. List of Peering connection information.
    { # VPC Peering details.
      "dnsZones": [ # Optional. List of DNS zones for DNS peering with the customer VPC network.
        "A String",
      ],
      "targetVpcNetwork": "A String", # Required. The name of the Target VPC network name in the format: `projects/{project}/global/networks/{network}
    },
  ],
  "requestId": "A String", # Optional. An optional 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).
  "validateOnly": True or False, # Optional. If set, validates request by executing a dry-run which would not alter the resource in any way.
}

  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.
  },
}