{ "rootUrl": "https://beyondcorp.googleapis.com/", "canonicalName": "BeyondCorp", "description": "Chrome Enterprise Premium is a secure enterprise browsing solution that provides secure access to applications and resources, and offers integrated threat and data protection. It adds an extra layer of security to safeguard your Chrome browser environment, including Data Loss Prevention (DLP), real-time URL and file scanning, and Context-Aware Access for SaaS and web apps.", "discoveryVersion": "v1", "schemas": { "GoogleCloudBeyondcorpAppconnectorsV1ImageConfig": { "description": "ImageConfig defines the control plane images to run.", "id": "GoogleCloudBeyondcorpAppconnectorsV1ImageConfig", "type": "object", "properties": { "targetImage": { "description": "The initial image the remote agent will attempt to run for the control plane. Format would be a gcr image path, e.g.: gcr.io/PROJECT-ID/my-image:tag1", "type": "string" }, "stableImage": { "type": "string", "description": "The stable image that the remote agent will fallback to if the target image fails. Format would be a gcr image path, e.g.: gcr.io/PROJECT-ID/my-image:tag1" } } }, "GoogleCloudBeyondcorpSecuritygatewaysV1ApplicationUpstreamExternal": { "description": "Endpoints to forward traffic to.", "id": "GoogleCloudBeyondcorpSecuritygatewaysV1ApplicationUpstreamExternal", "type": "object", "properties": { "endpoints": { "description": "Required. List of the endpoints to forward traffic to.", "items": { "$ref": "GoogleCloudBeyondcorpSecuritygatewaysV1Endpoint" }, "type": "array" } } }, "GoogleCloudBeyondcorpSecuritygatewaysV1ApplicationUpstream": { "id": "GoogleCloudBeyondcorpSecuritygatewaysV1ApplicationUpstream", "description": "Which upstream resource to forward traffic to.", "type": "object", "properties": { "network": { "description": "Network to forward traffic to.", "$ref": "GoogleCloudBeyondcorpSecuritygatewaysV1ApplicationUpstreamNetwork" }, "external": { "description": "List of the external endpoints to forward traffic to.", "$ref": "GoogleCloudBeyondcorpSecuritygatewaysV1ApplicationUpstreamExternal" }, "proxyProtocol": { "description": "Optional. Enables proxy protocol configuration for the upstream.", "$ref": "GoogleCloudBeyondcorpSecuritygatewaysV1ProxyProtocolConfig" }, "egressPolicy": { "description": "Optional. Routing policy information.", "$ref": "GoogleCloudBeyondcorpSecuritygatewaysV1EgressPolicy" } } }, "CloudSecurityZerotrustApplinkAppConnectorProtoGateway": { "type": "object", "properties": { "zone": { "type": "string", "description": "zone represents the zone the instance belongs. It is derived from the gateway URL. For example, zone=${zone} assuming a gateway URL. https://www.googleapis.com/compute/${version}/projects/${project}/zones/${zone}/instances/${instance}" }, "interface": { "description": "interface specifies the network interface of the gateway to connect to.", "type": "string" }, "project": { "type": "string", "description": "project is the tenant project the gateway belongs to. Different from the project in the connection, it is a BeyondCorpAPI internally created project to manage all the gateways. It is sharing the same network with the consumer project user owned. It is derived from the gateway URL. For example, project=${project} assuming a gateway URL. https://www.googleapis.com/compute/${version}/projects/${project}/zones/${zone}/instances/${instance}" }, "port": { "description": "port specifies the port of the gateway for tunnel connections from the connectors.", "type": "integer", "format": "uint32" }, "selfLink": { "type": "string", "description": "self_link is the gateway URL in the form https://www.googleapis.com/compute/${version}/projects/${project}/zones/${zone}/instances/${instance}" }, "name": { "description": "name is the name of an instance running a gateway. It is the unique ID for a gateway. All gateways under the same connection have the same prefix. It is derived from the gateway URL. For example, name=${instance} assuming a gateway URL. https://www.googleapis.com/compute/${version}/projects/${project}/zones/${zone}/instances/${instance}", "type": "string" } }, "id": "CloudSecurityZerotrustApplinkAppConnectorProtoGateway", "description": "Gateway represents a GCE VM Instance endpoint for use by IAP TCP." }, "GoogleCloudBeyondcorpPartnerservicesV1alphaPartnerServiceOperationMetadata": { "description": "Represents the metadata of the long-running operation.", "id": "GoogleCloudBeyondcorpPartnerservicesV1alphaPartnerServiceOperationMetadata", "deprecated": true, "properties": { "requestedCancellation": { "description": "Output only. Identifies whether the caller has requested cancellation of the operation. Operations that have successfully been cancelled have Operation.error value with a google.rpc.Status.code of 1, corresponding to `Code.CANCELLED`.", "type": "boolean", "readOnly": true }, "endTime": { "description": "Output only. The time the operation finished running.", "type": "string", "readOnly": true, "format": "google-datetime" }, "verb": { "readOnly": true, "type": "string", "description": "Output only. Name of the verb executed by the operation." }, "statusMessage": { "description": "Output only. Human-readable status of the operation, if any.", "readOnly": true, "type": "string" }, "apiVersion": { "type": "string", "readOnly": true, "description": "Output only. API version used to start the operation." }, "createTime": { "type": "string", "readOnly": true, "format": "google-datetime", "description": "Output only. The time the operation was created." }, "target": { "description": "Output only. Server-defined resource path for the target of the operation.", "type": "string", "readOnly": true } }, "type": "object" }, "GoogleCloudBeyondcorpSecuritygatewaysV1Application": { "type": "object", "properties": { "endpointMatchers": { "type": "array", "description": "Optional. An array of conditions to match the application's network endpoint. Each element in the array is an EndpointMatcher object, which defines a specific combination of a hostname pattern and one or more ports. The application is considered matched if at least one of the EndpointMatcher conditions in this array is met (the conditions are combined using OR logic). Each EndpointMatcher must contain a hostname pattern, such as \"example.com\", and one or more port numbers specified as a string, such as \"443\". Hostname and port number examples: \"*.example.com\", \"443\" \"example.com\" and \"22\" \"example.com\" and \"22,33\"", "items": { "$ref": "GoogleCloudBeyondcorpSecuritygatewaysV1EndpointMatcher" } }, "createTime": { "readOnly": true, "format": "google-datetime", "type": "string", "description": "Output only. Timestamp when the resource was created." }, "displayName": { "description": "Optional. An arbitrary user-provided name for the application resource. Cannot exceed 64 characters.", "type": "string" }, "upstreams": { "description": "Optional. Which upstream resources to forward traffic to.", "items": { "$ref": "GoogleCloudBeyondcorpSecuritygatewaysV1ApplicationUpstream" }, "type": "array" }, "name": { "type": "string", "description": "Identifier. Name of the resource." }, "updateTime": { "description": "Output only. Timestamp when the resource was last modified.", "readOnly": true, "format": "google-datetime", "type": "string" }, "schema": { "description": "Optional. Type of the external application.", "type": "string", "enum": [ "SCHEMA_UNSPECIFIED", "PROXY_GATEWAY", "API_GATEWAY" ], "enumDescriptions": [ "Default value. This value is unused.", "Proxy which routes traffic to actual applications, like Netscaler Gateway.", "Service Discovery API endpoint when Service Discovery is enabled in Gateway." ] } }, "description": "The information about an application resource.", "id": "GoogleCloudBeyondcorpSecuritygatewaysV1Application" }, "GoogleCloudBeyondcorpAppconnectorsV1ContainerHealthDetails": { "id": "GoogleCloudBeyondcorpAppconnectorsV1ContainerHealthDetails", "description": "ContainerHealthDetails reflects the health details of a container.", "type": "object", "properties": { "expectedConfigVersion": { "description": "The version of the expected config.", "type": "string" }, "currentConfigVersion": { "type": "string", "description": "The version of the current config." }, "errorMsg": { "description": "The latest error message.", "type": "string" }, "extendedStatus": { "description": "The extended status. Such as ExitCode, StartedAt, FinishedAt, etc.", "type": "object", "additionalProperties": { "type": "string" } } } }, "AppGatewayOperationMetadata": { "type": "object", "properties": { "verb": { "readOnly": true, "type": "string", "description": "Output only. Name of the verb executed by the operation." }, "statusMessage": { "readOnly": true, "type": "string", "description": "Output only. Human-readable status of the operation, if any." }, "createTime": { "description": "Output only. The time the operation was created.", "readOnly": true, "format": "google-datetime", "type": "string" }, "target": { "type": "string", "readOnly": true, "description": "Output only. Server-defined resource path for the target of the operation." }, "apiVersion": { "readOnly": true, "type": "string", "description": "Output only. API version used to start the operation." }, "requestedCancellation": { "readOnly": true, "type": "boolean", "description": "Output only. Identifies whether the user has requested cancellation of the operation. Operations that have successfully been cancelled have google.longrunning.Operation.error value with a google.rpc.Status.code of `1`, corresponding to `Code.CANCELLED`." }, "endTime": { "description": "Output only. The time the operation finished running.", "readOnly": true, "format": "google-datetime", "type": "string" } }, "description": "Represents the metadata of the long-running operation.", "id": "AppGatewayOperationMetadata" }, "GoogleCloudBeyondcorpAppconnectorsV1alphaAppConnectorOperationMetadata": { "type": "object", "properties": { "apiVersion": { "description": "Output only. API version used to start the operation.", "type": "string", "readOnly": true }, "createTime": { "description": "Output only. The time the operation was created.", "readOnly": true, "format": "google-datetime", "type": "string" }, "target": { "type": "string", "readOnly": true, "description": "Output only. Server-defined resource path for the target of the operation." }, "verb": { "description": "Output only. Name of the verb executed by the operation.", "type": "string", "readOnly": true }, "statusMessage": { "description": "Output only. Human-readable status of the operation, if any.", "readOnly": true, "type": "string" }, "endTime": { "description": "Output only. The time the operation finished running.", "type": "string", "readOnly": true, "format": "google-datetime" }, "requestedCancellation": { "description": "Output only. Identifies whether the user has requested cancellation of the operation. Operations that have successfully been cancelled have google.longrunning.Operation.error value with a google.rpc.Status.code of `1`, corresponding to `Code.CANCELLED`.", "type": "boolean", "readOnly": true } }, "description": "Represents the metadata of the long-running operation.", "id": "GoogleCloudBeyondcorpAppconnectorsV1alphaAppConnectorOperationMetadata" }, "GoogleCloudBeyondcorpSecuritygatewaysV1EgressPolicy": { "id": "GoogleCloudBeyondcorpSecuritygatewaysV1EgressPolicy", "description": "Routing policy information.", "type": "object", "properties": { "regions": { "description": "Required. List of the regions where the application sends traffic.", "items": { "type": "string" }, "type": "array" } } }, "CloudSecurityZerotrustApplinkLogagentProtoLogAgentDetails": { "type": "object", "properties": {}, "id": "CloudSecurityZerotrustApplinkLogagentProtoLogAgentDetails", "description": "LogAgentDetails reflects the details of a log agent." }, "GoogleIamV1TestIamPermissionsRequest": { "type": "object", "properties": { "permissions": { "type": "array", "description": "The set of permissions to check for the `resource`. Permissions with wildcards (such as `*` or `storage.*`) are not allowed. For more information see [IAM Overview](https://cloud.google.com/iam/docs/overview#permissions).", "items": { "type": "string" } } }, "description": "Request message for `TestIamPermissions` method.", "id": "GoogleIamV1TestIamPermissionsRequest" }, "GoogleCloudBeyondcorpAppconnectionsV1AppConnectionOperationMetadata": { "type": "object", "properties": { "endTime": { "readOnly": true, "format": "google-datetime", "type": "string", "description": "Output only. The time the operation finished running." }, "requestedCancellation": { "readOnly": true, "type": "boolean", "description": "Output only. Identifies whether the user has requested cancellation of the operation. Operations that have successfully been cancelled have google.longrunning.Operation.error value with a google.rpc.Status.code of 1, corresponding to `Code.CANCELLED`." }, "createTime": { "readOnly": true, "format": "google-datetime", "type": "string", "description": "Output only. The time the operation was created." }, "target": { "description": "Output only. Server-defined resource path for the target of the operation.", "readOnly": true, "type": "string" }, "apiVersion": { "type": "string", "readOnly": true, "description": "Output only. API version used to start the operation." }, "verb": { "type": "string", "readOnly": true, "description": "Output only. Name of the verb executed by the operation." }, "statusMessage": { "description": "Output only. Human-readable status of the operation, if any.", "type": "string", "readOnly": true } }, "id": "GoogleCloudBeyondcorpAppconnectionsV1AppConnectionOperationMetadata", "description": "Represents the metadata of the long-running operation." }, "GoogleCloudBeyondcorpAppconnectorsV1AppConnectorOperationMetadata": { "type": "object", "properties": { "endTime": { "description": "Output only. The time the operation finished running.", "type": "string", "readOnly": true, "format": "google-datetime" }, "requestedCancellation": { "readOnly": true, "type": "boolean", "description": "Output only. Identifies whether the user has requested cancellation of the operation. Operations that have successfully been cancelled have google.longrunning.Operation.error value with a google.rpc.Status.code of `1`, corresponding to `Code.CANCELLED`." }, "createTime": { "description": "Output only. The time the operation was created.", "readOnly": true, "format": "google-datetime", "type": "string" }, "target": { "type": "string", "readOnly": true, "description": "Output only. Server-defined resource path for the target of the operation." }, "apiVersion": { "description": "Output only. API version used to start the operation.", "type": "string", "readOnly": true }, "verb": { "type": "string", "readOnly": true, "description": "Output only. Name of the verb executed by the operation." }, "statusMessage": { "type": "string", "readOnly": true, "description": "Output only. Human-readable status of the operation, if any." } }, "id": "GoogleCloudBeyondcorpAppconnectorsV1AppConnectorOperationMetadata", "description": "Represents the metadata of the long-running operation." }, "GoogleCloudBeyondcorpAppconnectionsV1ResolveAppConnectionsResponse": { "type": "object", "properties": { "nextPageToken": { "description": "A token to retrieve the next page of results, or empty if there are no more results in the list.", "type": "string" }, "unreachable": { "type": "array", "description": "A list of locations that could not be reached.", "items": { "type": "string" } }, "appConnectionDetails": { "type": "array", "description": "A list of BeyondCorp AppConnections with details in the project.", "items": { "$ref": "GoogleCloudBeyondcorpAppconnectionsV1ResolveAppConnectionsResponseAppConnectionDetails" } } }, "id": "GoogleCloudBeyondcorpAppconnectionsV1ResolveAppConnectionsResponse", "description": "Response message for BeyondCorp.ResolveAppConnections." }, "GoogleCloudBeyondcorpSecuritygatewaysV1InternetGateway": { "id": "GoogleCloudBeyondcorpSecuritygatewaysV1InternetGateway", "description": "Represents the Internet Gateway configuration.", "type": "object", "properties": { "assignedIps": { "description": "Output only. List of IP addresses assigned to the Cloud NAT.", "items": { "type": "string" }, "type": "array", "readOnly": true } } }, "GoogleCloudBeyondcorpAppconnectionsV1AppConnectionApplicationEndpoint": { "id": "GoogleCloudBeyondcorpAppconnectionsV1AppConnectionApplicationEndpoint", "description": "ApplicationEndpoint represents a remote application endpoint.", "type": "object", "properties": { "host": { "type": "string", "description": "Required. Hostname or IP address of the remote application endpoint." }, "port": { "description": "Required. Port of the remote application endpoint.", "format": "int32", "type": "integer" } } }, "GoogleCloudBeyondcorpAppconnectorsV1NotificationConfig": { "id": "GoogleCloudBeyondcorpAppconnectorsV1NotificationConfig", "description": "NotificationConfig defines the mechanisms to notify instance agent.", "type": "object", "properties": { "pubsubNotification": { "description": "Cloud Pub/Sub Configuration to receive notifications.", "$ref": "GoogleCloudBeyondcorpAppconnectorsV1NotificationConfigCloudPubSubNotificationConfig" } } }, "GoogleCloudBeyondcorpAppconnectorsV1RemoteAgentDetails": { "description": "RemoteAgentDetails reflects the details of a remote agent.", "id": "GoogleCloudBeyondcorpAppconnectorsV1RemoteAgentDetails", "type": "object", "properties": {} }, "GoogleCloudBeyondcorpConnectionsV1alphaConnectionOperationMetadata": { "type": "object", "properties": { "endTime": { "description": "Output only. The time the operation finished running.", "readOnly": true, "format": "google-datetime", "type": "string" }, "requestedCancellation": { "description": "Output only. Identifies whether the user has requested cancellation of the operation. Operations that have successfully been cancelled have Operation.error value with a google.rpc.Status.code of 1, corresponding to `Code.CANCELLED`.", "readOnly": true, "type": "boolean" }, "createTime": { "description": "Output only. The time the operation was created.", "readOnly": true, "format": "google-datetime", "type": "string" }, "target": { "readOnly": true, "type": "string", "description": "Output only. Server-defined resource path for the target of the operation." }, "apiVersion": { "description": "Output only. API version used to start the operation.", "type": "string", "readOnly": true }, "verb": { "description": "Output only. Name of the verb executed by the operation.", "readOnly": true, "type": "string" }, "statusMessage": { "description": "Output only. Human-readable status of the operation, if any.", "readOnly": true, "type": "string" } }, "id": "GoogleCloudBeyondcorpConnectionsV1alphaConnectionOperationMetadata", "description": "Represents the metadata of the long-running operation." }, "Tunnelv1ProtoTunnelerInfo": { "type": "object", "properties": { "latestErr": { "description": "latest_err stores the Error for the latest tunneler failure. Gets reset everytime the tunneler is retried by tunManager.", "$ref": "Tunnelv1ProtoTunnelerError" }, "totalRetryCount": { "format": "uint32", "type": "integer", "description": "total_retry_count stores the total number of times the tunneler has been retried by tunManager." }, "backoffRetryCount": { "description": "backoff_retry_count stores the number of times the tunneler has been retried by tunManager for current backoff sequence. Gets reset to 0 if time difference between 2 consecutive retries exceeds backoffRetryResetTime.", "type": "integer", "format": "uint32" }, "id": { "description": "id is the unique id of a tunneler.", "type": "string" }, "latestRetryTime": { "description": "latest_retry_time stores the time when the tunneler was last restarted.", "type": "string", "format": "google-datetime" } }, "description": "TunnelerInfo contains metadata about tunneler launched by connection manager.", "id": "Tunnelv1ProtoTunnelerInfo" }, "GoogleCloudBeyondcorpAppconnectorsV1ListAppConnectorsResponse": { "type": "object", "properties": { "appConnectors": { "type": "array", "description": "A list of BeyondCorp AppConnectors in the project.", "items": { "$ref": "GoogleCloudBeyondcorpAppconnectorsV1AppConnector" } }, "unreachable": { "type": "array", "description": "A list of locations that could not be reached.", "items": { "type": "string" } }, "nextPageToken": { "type": "string", "description": "A token to retrieve the next page of results, or empty if there are no more results in the list." } }, "id": "GoogleCloudBeyondcorpAppconnectorsV1ListAppConnectorsResponse", "description": "Response message for BeyondCorp.ListAppConnectors." }, "AppGateway": { "id": "AppGateway", "description": "A BeyondCorp AppGateway resource represents a BeyondCorp protected AppGateway to a remote application. It creates all the necessary GCP components needed for creating a BeyondCorp protected AppGateway. Multiple connectors can be authorised for a single AppGateway.", "type": "object", "properties": { "name": { "type": "string", "description": "Required. Unique resource name of the AppGateway. The name is ignored when creating an AppGateway." }, "updateTime": { "readOnly": true, "format": "google-datetime", "type": "string", "description": "Output only. Timestamp when the resource was last modified." }, "hostType": { "enumDescriptions": [ "Default value. This value is unused.", "AppGateway hosted in a GCP regional managed instance group." ], "type": "string", "enum": [ "HOST_TYPE_UNSPECIFIED", "GCP_REGIONAL_MIG" ], "description": "Required. The type of hosting used by the AppGateway." }, "displayName": { "type": "string", "description": "Optional. An arbitrary user-provided name for the AppGateway. Cannot exceed 64 characters." }, "uri": { "readOnly": true, "type": "string", "description": "Output only. Server-defined URI for this resource." }, "allocatedConnections": { "description": "Output only. A list of connections allocated for the Gateway", "items": { "$ref": "AllocatedConnection" }, "type": "array", "readOnly": true }, "uid": { "description": "Output only. A unique identifier for the instance generated by the system.", "readOnly": true, "type": "string" }, "state": { "enumDescriptions": [ "Default value. This value is unused.", "AppGateway is being created.", "AppGateway has been created.", "AppGateway's configuration is being updated.", "AppGateway is being deleted.", "AppGateway is down and may be restored in the future. This happens when CCFE sends ProjectState = OFF." ], "type": "string", "readOnly": true, "enum": [ "STATE_UNSPECIFIED", "CREATING", "CREATED", "UPDATING", "DELETING", "DOWN" ], "description": "Output only. The current state of the AppGateway." }, "type": { "description": "Required. The type of network connectivity used by the AppGateway.", "enumDescriptions": [ "Default value. This value is unused.", "TCP Proxy based BeyondCorp Connection. API will default to this if unset." ], "type": "string", "enum": [ "TYPE_UNSPECIFIED", "TCP_PROXY" ] }, "satisfiesPzs": { "description": "Output only. Reserved for future use.", "readOnly": true, "type": "boolean" }, "createTime": { "readOnly": true, "format": "google-datetime", "type": "string", "description": "Output only. Timestamp when the resource was created." }, "labels": { "description": "Optional. Resource labels to represent user provided metadata.", "type": "object", "additionalProperties": { "type": "string" } }, "satisfiesPzi": { "description": "Output only. Reserved for future use.", "readOnly": true, "type": "boolean" } } }, "Empty": { "type": "object", "properties": {}, "id": "Empty", "description": "A generic empty message that you can re-use to avoid defining duplicated empty messages in your APIs. A typical example is to use it as the request or the response type of an API method. For instance: service Foo { rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty); }" }, "GoogleTypeExpr": { "id": "GoogleTypeExpr", "description": "Represents a textual expression in the Common Expression Language (CEL) syntax. CEL is a C-like expression language. The syntax and semantics of CEL are documented at https://github.com/google/cel-spec. Example (Comparison): title: \"Summary size limit\" description: \"Determines if a summary is less than 100 chars\" expression: \"document.summary.size() \u003c 100\" Example (Equality): title: \"Requestor is owner\" description: \"Determines if requestor is the document owner\" expression: \"document.owner == request.auth.claims.email\" Example (Logic): title: \"Public documents\" description: \"Determine whether the document should be publicly visible\" expression: \"document.type != 'private' && document.type != 'internal'\" Example (Data Manipulation): title: \"Notification string\" description: \"Create a notification string with a timestamp.\" expression: \"'New message received at ' + string(document.create_time)\" The exact variables and functions that may be referenced within an expression are determined by the service that evaluates it. See the service documentation for additional information.", "type": "object", "properties": { "location": { "description": "Optional. String indicating the location of the expression for error reporting, e.g. a file name and a position in the file.", "type": "string" }, "title": { "description": "Optional. Title for the expression, i.e. a short string describing its purpose. This can be used e.g. in UIs which allow to enter the expression.", "type": "string" }, "expression": { "description": "Textual representation of an expression in Common Expression Language syntax.", "type": "string" }, "description": { "description": "Optional. Description of the expression. This is a longer text which describes the expression, e.g. when hovered over it in a UI.", "type": "string" } } }, "GoogleCloudLocationListLocationsResponse": { "description": "The response message for Locations.ListLocations.", "id": "GoogleCloudLocationListLocationsResponse", "type": "object", "properties": { "locations": { "description": "A list of locations that matches the specified filter in the request.", "items": { "$ref": "GoogleCloudLocationLocation" }, "type": "array" }, "nextPageToken": { "type": "string", "description": "The standard List next-page token." } } }, "GoogleCloudBeyondcorpAppconnectorsV1AppConnectorPrincipalInfo": { "type": "object", "properties": { "serviceAccount": { "description": "A GCP service account.", "$ref": "GoogleCloudBeyondcorpAppconnectorsV1AppConnectorPrincipalInfoServiceAccount" } }, "id": "GoogleCloudBeyondcorpAppconnectorsV1AppConnectorPrincipalInfo", "description": "PrincipalInfo represents an Identity oneof." }, "GoogleCloudBeyondcorpAppconnectorsV1alphaRemoteAgentDetails": { "type": "object", "properties": {}, "description": "RemoteAgentDetails reflects the details of a remote agent.", "id": "GoogleCloudBeyondcorpAppconnectorsV1alphaRemoteAgentDetails" }, "GoogleLongrunningCancelOperationRequest": { "type": "object", "properties": {}, "description": "The request message for Operations.CancelOperation.", "id": "GoogleLongrunningCancelOperationRequest" }, "CloudSecurityZerotrustApplinkAppConnectorProtoConnectionConfig": { "id": "CloudSecurityZerotrustApplinkAppConnectorProtoConnectionConfig", "description": "ConnectionConfig represents a Connection Configuration object.", "type": "object", "properties": { "applicationEndpoint": { "description": "application_endpoint is the endpoint of the application the form of host:port. For example, \"localhost:80\".", "type": "string" }, "gateway": { "type": "array", "description": "gateway lists all instances running a gateway in GCP. They all connect to a connector on the host.", "items": { "$ref": "CloudSecurityZerotrustApplinkAppConnectorProtoGateway" } }, "name": { "type": "string", "description": "name is the unique ID for each connection. TODO(b/190732451) returns connection name from user-specified name in config. Now, name = ${application_name}:${application_endpoint}" }, "tunnelsPerGateway": { "description": "tunnels_per_gateway reflects the number of tunnels between a connector and a gateway.", "format": "uint32", "type": "integer" }, "project": { "description": "project represents the consumer project the connection belongs to.", "type": "string" }, "applicationName": { "description": "application_name represents the given name of the application the connection is connecting with.", "type": "string" }, "userPort": { "format": "int32", "type": "integer", "description": "user_port specifies the reserved port on gateways for user connections." } } }, "GoogleIamV1Binding": { "type": "object", "properties": { "members": { "description": "Specifies the principals requesting access for a Google Cloud resource. `members` can have the following values: * `allUsers`: A special identifier that represents anyone who is on the internet; with or without a Google account. * `allAuthenticatedUsers`: A special identifier that represents anyone who is authenticated with a Google account or a service account. Does not include identities that come from external identity providers (IdPs) through identity federation. * `user:{emailid}`: An email address that represents a specific Google account. For example, `alice@example.com` . * `serviceAccount:{emailid}`: An email address that represents a Google service account. For example, `my-other-app@appspot.gserviceaccount.com`. * `serviceAccount:{projectid}.svc.id.goog[{namespace}/{kubernetes-sa}]`: An identifier for a [Kubernetes service account](https://cloud.google.com/kubernetes-engine/docs/how-to/kubernetes-service-accounts). For example, `my-project.svc.id.goog[my-namespace/my-kubernetes-sa]`. * `group:{emailid}`: An email address that represents a Google group. For example, `admins@example.com`. * `domain:{domain}`: The G Suite domain (primary) that represents all the users of that domain. For example, `google.com` or `example.com`. * `principal://iam.googleapis.com/locations/global/workforcePools/{pool_id}/subject/{subject_attribute_value}`: A single identity in a workforce identity pool. * `principalSet://iam.googleapis.com/locations/global/workforcePools/{pool_id}/group/{group_id}`: All workforce identities in a group. * `principalSet://iam.googleapis.com/locations/global/workforcePools/{pool_id}/attribute.{attribute_name}/{attribute_value}`: All workforce identities with a specific attribute value. * `principalSet://iam.googleapis.com/locations/global/workforcePools/{pool_id}/*`: All identities in a workforce identity pool. * `principal://iam.googleapis.com/projects/{project_number}/locations/global/workloadIdentityPools/{pool_id}/subject/{subject_attribute_value}`: A single identity in a workload identity pool. * `principalSet://iam.googleapis.com/projects/{project_number}/locations/global/workloadIdentityPools/{pool_id}/group/{group_id}`: A workload identity pool group. * `principalSet://iam.googleapis.com/projects/{project_number}/locations/global/workloadIdentityPools/{pool_id}/attribute.{attribute_name}/{attribute_value}`: All identities in a workload identity pool with a certain attribute. * `principalSet://iam.googleapis.com/projects/{project_number}/locations/global/workloadIdentityPools/{pool_id}/*`: All identities in a workload identity pool. * `deleted:user:{emailid}?uid={uniqueid}`: An email address (plus unique identifier) representing a user that has been recently deleted. For example, `alice@example.com?uid=123456789012345678901`. If the user is recovered, this value reverts to `user:{emailid}` and the recovered user retains the role in the binding. * `deleted:serviceAccount:{emailid}?uid={uniqueid}`: An email address (plus unique identifier) representing a service account that has been recently deleted. For example, `my-other-app@appspot.gserviceaccount.com?uid=123456789012345678901`. If the service account is undeleted, this value reverts to `serviceAccount:{emailid}` and the undeleted service account retains the role in the binding. * `deleted:group:{emailid}?uid={uniqueid}`: An email address (plus unique identifier) representing a Google group that has been recently deleted. For example, `admins@example.com?uid=123456789012345678901`. If the group is recovered, this value reverts to `group:{emailid}` and the recovered group retains the role in the binding. * `deleted:principal://iam.googleapis.com/locations/global/workforcePools/{pool_id}/subject/{subject_attribute_value}`: Deleted single identity in a workforce identity pool. For example, `deleted:principal://iam.googleapis.com/locations/global/workforcePools/my-pool-id/subject/my-subject-attribute-value`.", "items": { "type": "string" }, "type": "array" }, "role": { "type": "string", "description": "Role that is assigned to the list of `members`, or principals. For example, `roles/viewer`, `roles/editor`, or `roles/owner`. For an overview of the IAM roles and permissions, see the [IAM documentation](https://cloud.google.com/iam/docs/roles-overview). For a list of the available pre-defined roles, see [here](https://cloud.google.com/iam/docs/understanding-roles)." }, "condition": { "description": "The condition that is associated with this binding. If the condition evaluates to `true`, then this binding applies to the current request. If the condition evaluates to `false`, then this binding does not apply to the current request. However, a different role binding might grant the same role to one or more of the principals in this binding. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies).", "$ref": "GoogleTypeExpr" } }, "id": "GoogleIamV1Binding", "description": "Associates `members`, or principals, with a `role`." }, "GoogleCloudBeyondcorpSecuritygatewaysV1EndpointMatcher": { "id": "GoogleCloudBeyondcorpSecuritygatewaysV1EndpointMatcher", "description": "EndpointMatcher contains the information of the endpoint that will match the application.", "type": "object", "properties": { "hostname": { "type": "string", "description": "Required. Hostname of the application." }, "ports": { "description": "Required. The ports of the application.", "items": { "type": "integer", "format": "int32" }, "type": "array" } } }, "GoogleCloudBeyondcorpSecuritygatewaysV1Endpoint": { "type": "object", "properties": { "port": { "description": "Required. Port of the endpoint.", "format": "int32", "type": "integer" }, "hostname": { "type": "string", "description": "Required. Hostname of the endpoint." } }, "description": "Internet Gateway endpoint to forward traffic to.", "id": "GoogleCloudBeyondcorpSecuritygatewaysV1Endpoint" }, "GoogleCloudBeyondcorpAppconnectionsV1AppConnection": { "description": "A BeyondCorp AppConnection resource represents a BeyondCorp protected AppConnection to a remote application. It creates all the necessary GCP components needed for creating a BeyondCorp protected AppConnection. Multiple connectors can be authorized for a single AppConnection.", "id": "GoogleCloudBeyondcorpAppconnectionsV1AppConnection", "type": "object", "properties": { "applicationEndpoint": { "description": "Required. Address of the remote application endpoint for the BeyondCorp AppConnection.", "$ref": "GoogleCloudBeyondcorpAppconnectionsV1AppConnectionApplicationEndpoint" }, "gateway": { "description": "Optional. Gateway used by the AppConnection.", "$ref": "GoogleCloudBeyondcorpAppconnectionsV1AppConnectionGateway" }, "name": { "type": "string", "description": "Required. Unique resource name of the AppConnection. The name is ignored when creating a AppConnection." }, "updateTime": { "description": "Output only. Timestamp when the resource was last modified.", "readOnly": true, "format": "google-datetime", "type": "string" }, "displayName": { "type": "string", "description": "Optional. An arbitrary user-provided name for the AppConnection. Cannot exceed 64 characters." }, "uid": { "description": "Output only. A unique identifier for the instance generated by the system.", "type": "string", "readOnly": true }, "type": { "type": "string", "enum": [ "TYPE_UNSPECIFIED", "TCP_PROXY" ], "enumDescriptions": [ "Default value. This value is unused.", "TCP Proxy based BeyondCorp AppConnection. API will default to this if unset." ], "description": "Required. The type of network connectivity used by the AppConnection." }, "satisfiesPzs": { "description": "Output only. Reserved for future use.", "type": "boolean", "readOnly": true }, "state": { "description": "Output only. The current state of the AppConnection.", "readOnly": true, "enum": [ "STATE_UNSPECIFIED", "CREATING", "CREATED", "UPDATING", "DELETING", "DOWN" ], "enumDescriptions": [ "Default value. This value is unused.", "AppConnection is being created.", "AppConnection has been created.", "AppConnection's configuration is being updated.", "AppConnection is being deleted.", "AppConnection is down and may be restored in the future. This happens when CCFE sends ProjectState = OFF." ], "type": "string" }, "labels": { "description": "Optional. Resource labels to represent user provided metadata.", "type": "object", "additionalProperties": { "type": "string" } }, "connectors": { "description": "Optional. List of [google.cloud.beyondcorp.v1main.Connector.name] that are authorized to be associated with this AppConnection.", "items": { "type": "string" }, "type": "array" }, "createTime": { "description": "Output only. Timestamp when the resource was created.", "readOnly": true, "format": "google-datetime", "type": "string" }, "satisfiesPzi": { "description": "Output only. Reserved for future use.", "readOnly": true, "type": "boolean" } } }, "AllocatedConnection": { "id": "AllocatedConnection", "description": "Allocated connection of the AppGateway.", "type": "object", "properties": { "pscUri": { "description": "Required. The PSC uri of an allocated connection", "type": "string" }, "ingressPort": { "description": "Required. The ingress port of an allocated connection", "format": "int32", "type": "integer" } } }, "GoogleCloudBeyondcorpSecuritygatewaysV1Hub": { "description": "The Hub message contains information pertaining to the regional data path deployments.", "id": "GoogleCloudBeyondcorpSecuritygatewaysV1Hub", "type": "object", "properties": { "internetGateway": { "description": "Optional. Internet Gateway configuration.", "$ref": "GoogleCloudBeyondcorpSecuritygatewaysV1InternetGateway" } } }, "GoogleCloudBeyondcorpConnectorsV1alphaContainerHealthDetails": { "id": "GoogleCloudBeyondcorpConnectorsV1alphaContainerHealthDetails", "description": "ContainerHealthDetails reflects the health details of a container.", "type": "object", "properties": { "expectedConfigVersion": { "description": "The version of the expected config.", "type": "string" }, "currentConfigVersion": { "type": "string", "description": "The version of the current config." }, "errorMsg": { "description": "The latest error message.", "type": "string" }, "extendedStatus": { "description": "The extended status. Such as ExitCode, StartedAt, FinishedAt, etc.", "type": "object", "additionalProperties": { "type": "string" } } } }, "GoogleLongrunningListOperationsResponse": { "type": "object", "properties": { "unreachable": { "description": "Unordered list. Unreachable resources. Populated when the request sets `ListOperationsRequest.return_partial_success` and reads across collections. For example, when attempting to list all resources across all supported locations.", "items": { "type": "string" }, "type": "array" }, "operations": { "description": "A list of operations that matches the specified filter in the request.", "items": { "$ref": "GoogleLongrunningOperation" }, "type": "array" }, "nextPageToken": { "description": "The standard List next-page token.", "type": "string" } }, "id": "GoogleLongrunningListOperationsResponse", "description": "The response message for Operations.ListOperations." }, "GoogleCloudBeyondcorpSecuritygatewaysV1ContextualHeadersDelegatedUserInfo": { "description": "The configuration information for the delegated user.", "id": "GoogleCloudBeyondcorpSecuritygatewaysV1ContextualHeadersDelegatedUserInfo", "type": "object", "properties": { "outputType": { "description": "Optional. The delegated user's information.", "type": "string", "enum": [ "OUTPUT_TYPE_UNSPECIFIED", "PROTOBUF", "JSON", "NONE" ], "enumDescriptions": [ "The unspecified output type.", "Protobuf output type.", "JSON output type.", "Explicitly disable header output." ] } } }, "GoogleCloudBeyondcorpAppconnectorsV1AppConnectorInstanceConfig": { "id": "GoogleCloudBeyondcorpAppconnectorsV1AppConnectorInstanceConfig", "description": "AppConnectorInstanceConfig defines the instance config of a AppConnector.", "type": "object", "properties": { "instanceConfig": { "type": "object", "additionalProperties": { "type": "any", "description": "Properties of the object. Contains field @type with type URL." }, "description": "The SLM instance agent configuration." }, "imageConfig": { "description": "ImageConfig defines the GCR images to run for the remote agent's control plane.", "$ref": "GoogleCloudBeyondcorpAppconnectorsV1ImageConfig" }, "sequenceNumber": { "type": "string", "format": "int64", "description": "Required. A monotonically increasing number generated and maintained by the API provider. Every time a config changes in the backend, the sequenceNumber should be bumped up to reflect the change." }, "notificationConfig": { "description": "NotificationConfig defines the notification mechanism that the remote instance should subscribe to in order to receive notification.", "$ref": "GoogleCloudBeyondcorpAppconnectorsV1NotificationConfig" } } }, "GoogleCloudBeyondcorpAppconnectorsV1NotificationConfigCloudPubSubNotificationConfig": { "type": "object", "properties": { "pubsubSubscription": { "type": "string", "description": "The Pub/Sub subscription the AppConnector uses to receive notifications." } }, "description": "The configuration for Pub/Sub messaging for the AppConnector.", "id": "GoogleCloudBeyondcorpAppconnectorsV1NotificationConfigCloudPubSubNotificationConfig" }, "GoogleCloudBeyondcorpAppconnectorsV1ResolveInstanceConfigResponse": { "type": "object", "properties": { "instanceConfig": { "description": "AppConnectorInstanceConfig.", "$ref": "GoogleCloudBeyondcorpAppconnectorsV1AppConnectorInstanceConfig" } }, "id": "GoogleCloudBeyondcorpAppconnectorsV1ResolveInstanceConfigResponse", "description": "Response message for BeyondCorp.ResolveInstanceConfig." }, "GoogleCloudBeyondcorpSecuritygatewaysV1ContextualHeadersDelegatedGroupInfo": { "id": "GoogleCloudBeyondcorpSecuritygatewaysV1ContextualHeadersDelegatedGroupInfo", "description": "The delegated group configuration details.", "type": "object", "properties": { "outputType": { "type": "string", "enum": [ "OUTPUT_TYPE_UNSPECIFIED", "PROTOBUF", "JSON", "NONE" ], "enumDescriptions": [ "The unspecified output type.", "Protobuf output type.", "JSON output type.", "Explicitly disable header output." ], "description": "Optional. The output type of the delegated group information." } } }, "GoogleCloudBeyondcorpConnectorsV1alphaRemoteAgentDetails": { "type": "object", "properties": {}, "id": "GoogleCloudBeyondcorpConnectorsV1alphaRemoteAgentDetails", "description": "RemoteAgentDetails reflects the details of a remote agent." }, "CloudSecurityZerotrustApplinkAppConnectorProtoConnectorDetails": { "type": "object", "properties": {}, "description": "ConnectorDetails reflects the details of a connector.", "id": "CloudSecurityZerotrustApplinkAppConnectorProtoConnectorDetails" }, "GoogleCloudBeyondcorpSecuritygatewaysV1ContextualHeadersDelegatedDeviceInfo": { "id": "GoogleCloudBeyondcorpSecuritygatewaysV1ContextualHeadersDelegatedDeviceInfo", "description": "The delegated device information configuration.", "type": "object", "properties": { "outputType": { "description": "Optional. The output type details for the delegated device.", "type": "string", "enum": [ "OUTPUT_TYPE_UNSPECIFIED", "PROTOBUF", "JSON", "NONE" ], "enumDescriptions": [ "The unspecified output type.", "Protobuf output type.", "JSON output type.", "Explicitly disable header output." ] } } }, "GoogleCloudBeyondcorpAppconnectionsV1AppConnectionGateway": { "type": "object", "properties": { "uri": { "description": "Output only. Server-defined URI for this resource.", "type": "string", "readOnly": true }, "type": { "description": "Required. The type of hosting used by the gateway.", "enumDescriptions": [ "Default value. This value is unused.", "Gateway hosted in a GCP regional managed instance group." ], "type": "string", "enum": [ "TYPE_UNSPECIFIED", "GCP_REGIONAL_MIG" ] }, "ingressPort": { "description": "Output only. Ingress port reserved on the gateways for this AppConnection, if not specified or zero, the default port is 19443.", "type": "integer", "readOnly": true, "format": "int32" }, "appGateway": { "description": "Required. AppGateway name in following format: `projects/{project_id}/locations/{location_id}/appgateways/{gateway_id}`", "type": "string" }, "l7psc": { "description": "Output only. L7 private service connection for this resource.", "readOnly": true, "type": "string" } }, "description": "Gateway represents a user facing component that serves as an entrance to enable connectivity.", "id": "GoogleCloudBeyondcorpAppconnectionsV1AppConnectionGateway" }, "GoogleIamV1SetIamPolicyRequest": { "id": "GoogleIamV1SetIamPolicyRequest", "description": "Request message for `SetIamPolicy` method.", "type": "object", "properties": { "policy": { "description": "REQUIRED: The complete policy to be applied to the `resource`. The size of the policy is limited to a few 10s of KB. An empty policy is a valid policy but certain Google Cloud services (such as Projects) might reject them.", "$ref": "GoogleIamV1Policy" }, "updateMask": { "description": "OPTIONAL: A FieldMask specifying which fields of the policy to modify. Only the fields in the mask will be modified. If no mask is provided, the following default mask is used: `paths: \"bindings, etag\"`", "format": "google-fieldmask", "type": "string" } } }, "GoogleCloudBeyondcorpAppconnectionsV1alphaAppConnectionOperationMetadata": { "type": "object", "properties": { "apiVersion": { "readOnly": true, "type": "string", "description": "Output only. API version used to start the operation." }, "createTime": { "type": "string", "readOnly": true, "format": "google-datetime", "description": "Output only. The time the operation was created." }, "target": { "readOnly": true, "type": "string", "description": "Output only. Server-defined resource path for the target of the operation." }, "verb": { "description": "Output only. Name of the verb executed by the operation.", "readOnly": true, "type": "string" }, "statusMessage": { "description": "Output only. Human-readable status of the operation, if any.", "readOnly": true, "type": "string" }, "endTime": { "description": "Output only. The time the operation finished running.", "type": "string", "readOnly": true, "format": "google-datetime" }, "requestedCancellation": { "type": "boolean", "readOnly": true, "description": "Output only. Identifies whether the user has requested cancellation of the operation. Operations that have successfully been cancelled have google.longrunning.Operation.error value with a google.rpc.Status.code of 1, corresponding to `Code.CANCELLED`." } }, "description": "Represents the metadata of the long-running operation.", "id": "GoogleCloudBeyondcorpAppconnectionsV1alphaAppConnectionOperationMetadata" }, "GoogleCloudBeyondcorpPartnerservicesV1mainPartnerServiceOperationMetadata": { "type": "object", "description": "Represents the metadata of the long-running operation.", "id": "GoogleCloudBeyondcorpPartnerservicesV1mainPartnerServiceOperationMetadata", "deprecated": true, "properties": { "endTime": { "description": "Output only. The time the operation finished running.", "type": "string", "readOnly": true, "format": "google-datetime" }, "requestedCancellation": { "description": "Output only. Identifies whether the caller has requested cancellation of the operation. Operations that have successfully been cancelled have Operation.error value with a google.rpc.Status.code of 1, corresponding to `Code.CANCELLED`.", "readOnly": true, "type": "boolean" }, "apiVersion": { "type": "string", "readOnly": true, "description": "Output only. API version used to start the operation." }, "createTime": { "description": "Output only. The time the operation was created.", "readOnly": true, "format": "google-datetime", "type": "string" }, "target": { "description": "Output only. Server-defined resource path for the target of the operation.", "readOnly": true, "type": "string" }, "verb": { "readOnly": true, "type": "string", "description": "Output only. Name of the verb executed by the operation." }, "statusMessage": { "type": "string", "readOnly": true, "description": "Output only. Human-readable status of the operation, if any." } } }, "GoogleCloudBeyondcorpSecuritygatewaysV1ListApplicationsResponse": { "id": "GoogleCloudBeyondcorpSecuritygatewaysV1ListApplicationsResponse", "description": "Message for response to listing Applications.", "type": "object", "properties": { "applications": { "type": "array", "description": "A list of BeyondCorp Application in the project.", "items": { "$ref": "GoogleCloudBeyondcorpSecuritygatewaysV1Application" } }, "unreachable": { "type": "array", "description": "A list of locations that could not be reached.", "items": { "type": "string" } }, "nextPageToken": { "type": "string", "description": "A token to retrieve the next page of results, or empty if there are no more results in the list." } } }, "GoogleCloudBeyondcorpSecuritygatewaysV1ServiceDiscoveryApiGateway": { "id": "GoogleCloudBeyondcorpSecuritygatewaysV1ServiceDiscoveryApiGateway", "description": "If Service Discovery is done through API, defines its settings.", "type": "object", "properties": { "resourceOverride": { "description": "Optional. Enables fetching resource model updates to alter service behavior per Chrome profile.", "$ref": "GoogleCloudBeyondcorpSecuritygatewaysV1ServiceDiscoveryApiGatewayOperationDescriptor" } } }, "GoogleCloudBeyondcorpSecuritygatewaysV1ServiceDiscoveryApiGatewayOperationDescriptor": { "description": "API operation descriptor.", "id": "GoogleCloudBeyondcorpSecuritygatewaysV1ServiceDiscoveryApiGatewayOperationDescriptor", "type": "object", "properties": { "path": { "type": "string", "description": "Optional. Contains the URI path fragment where HTTP request is sent." } } }, "GoogleCloudLocationLocation": { "id": "GoogleCloudLocationLocation", "description": "A resource that represents a Google Cloud location.", "type": "object", "properties": { "name": { "type": "string", "description": "Resource name for the location, which may vary between implementations. For example: `\"projects/example-project/locations/us-east1\"`" }, "locationId": { "type": "string", "description": "The canonical id for this location. For example: `\"us-east1\"`." }, "labels": { "description": "Cross-service attributes for the location. For example {\"cloud.googleapis.com/region\": \"us-east1\"}", "type": "object", "additionalProperties": { "type": "string" } }, "displayName": { "type": "string", "description": "The friendly name for this location, typically a nearby city name. For example, \"Tokyo\"." }, "metadata": { "type": "object", "additionalProperties": { "description": "Properties of the object. Contains field @type with type URL.", "type": "any" }, "description": "Service-specific metadata. For example the available capacity at the given location." } } }, "GoogleCloudBeyondcorpAppconnectionsV1ListAppConnectionsResponse": { "type": "object", "properties": { "unreachable": { "type": "array", "description": "A list of locations that could not be reached.", "items": { "type": "string" } }, "appConnections": { "description": "A list of BeyondCorp AppConnections in the project.", "items": { "$ref": "GoogleCloudBeyondcorpAppconnectionsV1AppConnection" }, "type": "array" }, "nextPageToken": { "type": "string", "description": "A token to retrieve the next page of results, or empty if there are no more results in the list." } }, "description": "Response message for BeyondCorp.ListAppConnections.", "id": "GoogleCloudBeyondcorpAppconnectionsV1ListAppConnectionsResponse" }, "GoogleLongrunningOperation": { "id": "GoogleLongrunningOperation", "description": "This resource represents a long-running operation that is the result of a network API call.", "type": "object", "properties": { "name": { "description": "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}`.", "type": "string" }, "done": { "type": "boolean", "description": "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": { "description": "The error result of the operation in case of failure or cancellation.", "$ref": "GoogleRpcStatus" }, "metadata": { "description": "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.", "type": "object", "additionalProperties": { "description": "Properties of the object. Contains field @type with type URL.", "type": "any" } }, "response": { "type": "object", "additionalProperties": { "description": "Properties of the object. Contains field @type with type URL.", "type": "any" }, "description": "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`." } } }, "GoogleCloudBeyondcorpAppgatewaysV1alphaAppGatewayOperationMetadata": { "type": "object", "properties": { "requestedCancellation": { "readOnly": true, "type": "boolean", "description": "Output only. Identifies whether the user has requested cancellation of the operation. Operations that have successfully been cancelled have google.longrunning.Operation.error value with a google.rpc.Status.code of `1`, corresponding to `Code.CANCELLED`." }, "endTime": { "type": "string", "readOnly": true, "format": "google-datetime", "description": "Output only. The time the operation finished running." }, "verb": { "readOnly": true, "type": "string", "description": "Output only. Name of the verb executed by the operation." }, "statusMessage": { "description": "Output only. Human-readable status of the operation, if any.", "readOnly": true, "type": "string" }, "createTime": { "readOnly": true, "format": "google-datetime", "type": "string", "description": "Output only. The time the operation was created." }, "target": { "readOnly": true, "type": "string", "description": "Output only. Server-defined resource path for the target of the operation." }, "apiVersion": { "description": "Output only. API version used to start the operation.", "type": "string", "readOnly": true } }, "id": "GoogleCloudBeyondcorpAppgatewaysV1alphaAppGatewayOperationMetadata", "description": "Represents the metadata of the long-running operation." }, "GoogleCloudBeyondcorpSecuritygatewaysV1SecurityGateway": { "id": "GoogleCloudBeyondcorpSecuritygatewaysV1SecurityGateway", "description": "The information about a security gateway resource.", "type": "object", "properties": { "state": { "enumDescriptions": [ "Default value. This value is unused.", "SecurityGateway is being created.", "SecurityGateway is being updated.", "SecurityGateway is being deleted.", "SecurityGateway is running.", "SecurityGateway is down and may be restored in the future.", "SecurityGateway encountered an error and is in an indeterministic state." ], "type": "string", "readOnly": true, "enum": [ "STATE_UNSPECIFIED", "CREATING", "UPDATING", "DELETING", "RUNNING", "DOWN", "ERROR" ], "description": "Output only. The operational state of the SecurityGateway." }, "name": { "description": "Identifier. Name of the resource.", "type": "string" }, "updateTime": { "type": "string", "readOnly": true, "format": "google-datetime", "description": "Output only. Timestamp when the resource was last modified." }, "serviceDiscovery": { "description": "Optional. Settings related to the Service Discovery.", "$ref": "GoogleCloudBeyondcorpSecuritygatewaysV1ServiceDiscovery" }, "delegatingServiceAccount": { "description": "Output only. Service account used for operations that involve resources in consumer projects.", "type": "string", "readOnly": true }, "createTime": { "description": "Output only. Timestamp when the resource was created.", "readOnly": true, "format": "google-datetime", "type": "string" }, "displayName": { "type": "string", "description": "Optional. An arbitrary user-provided name for the SecurityGateway. Cannot exceed 64 characters." }, "externalIps": { "description": "Output only. IP addresses that will be used for establishing connection to the endpoints.", "items": { "type": "string" }, "type": "array", "readOnly": true }, "hubs": { "description": "Optional. Map of Hubs that represents regional data path deployment with GCP region as a key.", "type": "object", "additionalProperties": { "$ref": "GoogleCloudBeyondcorpSecuritygatewaysV1Hub" } }, "proxyProtocolConfig": { "description": "Optional. Shared proxy configuration for all apps.", "$ref": "GoogleCloudBeyondcorpSecuritygatewaysV1ProxyProtocolConfig" }, "logging": { "description": "Optional. Configuration for Cloud Logging. If this field is present, the logging will be enabled.", "$ref": "GoogleCloudBeyondcorpSecuritygatewaysV1LoggingConfig" } } }, "GoogleCloudBeyondcorpAppconnectorsV1AppConnectorPrincipalInfoServiceAccount": { "description": "ServiceAccount represents a GCP service account.", "id": "GoogleCloudBeyondcorpAppconnectorsV1AppConnectorPrincipalInfoServiceAccount", "type": "object", "properties": { "email": { "type": "string", "description": "Email address of the service account." } } }, "GoogleCloudBeyondcorpAppconnectionsV1ResolveAppConnectionsResponseAppConnectionDetails": { "id": "GoogleCloudBeyondcorpAppconnectionsV1ResolveAppConnectionsResponseAppConnectionDetails", "description": "Details of the AppConnection.", "type": "object", "properties": { "appConnection": { "description": "A BeyondCorp AppConnection in the project.", "$ref": "GoogleCloudBeyondcorpAppconnectionsV1AppConnection" }, "recentMigVms": { "type": "array", "description": "If type=GCP_REGIONAL_MIG, contains most recent VM instances, like `https://www.googleapis.com/compute/v1/projects/{project_id}/zones/{zone_id}/instances/{instance_id}`.", "items": { "type": "string" } } } }, "GoogleCloudBeyondcorpSecuritygatewaysV1ProxyProtocolConfig": { "id": "GoogleCloudBeyondcorpSecuritygatewaysV1ProxyProtocolConfig", "description": "The configuration for the proxy.", "type": "object", "properties": { "gatewayIdentity": { "type": "string", "enum": [ "GATEWAY_IDENTITY_UNSPECIFIED", "RESOURCE_NAME" ], "enumDescriptions": [ "Unspecified gateway identity.", "Resource name for gateway identity, in the format: projects/{project_id}/locations/{location_id}/securityGateways/{security_gateway_id}" ], "description": "Optional. The security gateway identity configuration." }, "allowedClientHeaders": { "type": "array", "description": "Optional. List of the allowed client header names.", "items": { "type": "string" } }, "contextualHeaders": { "description": "Optional. Configuration for the contextual headers.", "$ref": "GoogleCloudBeyondcorpSecuritygatewaysV1ContextualHeaders" }, "metadataHeaders": { "type": "object", "additionalProperties": { "type": "string" }, "description": "Optional. Custom resource specific headers along with the values. The names should conform to RFC 9110: \u003eField names can contain alphanumeric characters, hyphens, and periods, can contain only ASCII-printable characters and tabs, and must start with a letter." }, "clientIp": { "description": "Optional. Client IP configuration. The client IP address is included if true.", "type": "boolean" } } }, "GoogleRpcStatus": { "type": "object", "properties": { "message": { "description": "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.", "type": "string" }, "details": { "type": "array", "description": "A list of messages that carry the error details. There is a common set of message types for APIs to use.", "items": { "type": "object", "additionalProperties": { "type": "any", "description": "Properties of the object. Contains field @type with type URL." } } }, "code": { "description": "The status code, which should be an enum value of google.rpc.Code.", "type": "integer", "format": "int32" } }, "id": "GoogleRpcStatus", "description": "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)." }, "GoogleIamV1AuditLogConfig": { "id": "GoogleIamV1AuditLogConfig", "description": "Provides the configuration for logging a type of permissions. Example: { \"audit_log_configs\": [ { \"log_type\": \"DATA_READ\", \"exempted_members\": [ \"user:jose@example.com\" ] }, { \"log_type\": \"DATA_WRITE\" } ] } This enables 'DATA_READ' and 'DATA_WRITE' logging, while exempting jose@example.com from DATA_READ logging.", "type": "object", "properties": { "logType": { "enumDescriptions": [ "Default case. Should never be this.", "Admin reads. Example: CloudIAM getIamPolicy", "Data writes. Example: CloudSQL Users create", "Data reads. Example: CloudSQL Users list" ], "type": "string", "enum": [ "LOG_TYPE_UNSPECIFIED", "ADMIN_READ", "DATA_WRITE", "DATA_READ" ], "description": "The log type that this config enables." }, "exemptedMembers": { "description": "Specifies the identities that do not cause logging for this type of permission. Follows the same format of Binding.members.", "items": { "type": "string" }, "type": "array" } } }, "GoogleCloudBeyondcorpAppconnectorsV1alphaContainerHealthDetails": { "type": "object", "properties": { "extendedStatus": { "type": "object", "additionalProperties": { "type": "string" }, "description": "The extended status. Such as ExitCode, StartedAt, FinishedAt, etc." }, "expectedConfigVersion": { "description": "The version of the expected config.", "type": "string" }, "currentConfigVersion": { "description": "The version of the current config.", "type": "string" }, "errorMsg": { "description": "The latest error message.", "type": "string" } }, "id": "GoogleCloudBeyondcorpAppconnectorsV1alphaContainerHealthDetails", "description": "ContainerHealthDetails reflects the health details of a container." }, "GoogleCloudBeyondcorpSecuritygatewaysV1ListSecurityGatewaysResponse": { "type": "object", "properties": { "nextPageToken": { "description": "A token to retrieve the next page of results, or empty if there are no more results in the list.", "type": "string" }, "securityGateways": { "type": "array", "description": "A list of BeyondCorp SecurityGateway in the project.", "items": { "$ref": "GoogleCloudBeyondcorpSecuritygatewaysV1SecurityGateway" } }, "unreachable": { "description": "A list of locations that could not be reached.", "items": { "type": "string" }, "type": "array" } }, "description": "Message for response to listing SecurityGateways.", "id": "GoogleCloudBeyondcorpSecuritygatewaysV1ListSecurityGatewaysResponse" }, "GoogleCloudBeyondcorpSecuritygatewaysV1ContextualHeaders": { "type": "object", "properties": { "userInfo": { "description": "Optional. User details.", "$ref": "GoogleCloudBeyondcorpSecuritygatewaysV1ContextualHeadersDelegatedUserInfo" }, "deviceInfo": { "description": "Optional. The device information configuration.", "$ref": "GoogleCloudBeyondcorpSecuritygatewaysV1ContextualHeadersDelegatedDeviceInfo" }, "groupInfo": { "description": "Optional. Group details.", "$ref": "GoogleCloudBeyondcorpSecuritygatewaysV1ContextualHeadersDelegatedGroupInfo" }, "outputType": { "type": "string", "enum": [ "OUTPUT_TYPE_UNSPECIFIED", "PROTOBUF", "JSON", "NONE" ], "enumDescriptions": [ "The unspecified output type.", "Protobuf output type.", "JSON output type.", "Explicitly disable header output." ], "description": "Optional. Default output type for all enabled headers." } }, "id": "GoogleCloudBeyondcorpSecuritygatewaysV1ContextualHeaders", "description": "Contextual headers configuration." }, "GoogleCloudBeyondcorpAppconnectorsV1ReportStatusRequest": { "type": "object", "properties": { "resourceInfo": { "description": "Required. Resource info of the connector.", "$ref": "GoogleCloudBeyondcorpAppconnectorsV1ResourceInfo" }, "validateOnly": { "description": "Optional. If set, validates request by executing a dry-run which would not alter the resource in any way.", "type": "boolean" }, "requestId": { "description": "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).", "type": "string" } }, "description": "Request report the connector status.", "id": "GoogleCloudBeyondcorpAppconnectorsV1ReportStatusRequest" }, "GoogleCloudBeyondcorpSecuritygatewaysV1ServiceDiscovery": { "type": "object", "properties": { "apiGateway": { "description": "Optional. External API configuration.", "$ref": "GoogleCloudBeyondcorpSecuritygatewaysV1ServiceDiscoveryApiGateway" } }, "id": "GoogleCloudBeyondcorpSecuritygatewaysV1ServiceDiscovery", "description": "Settings related to the Service Discovery." }, "GoogleCloudBeyondcorpSecuritygatewaysV1LoggingConfig": { "description": "Configuration for Cloud Logging.", "id": "GoogleCloudBeyondcorpSecuritygatewaysV1LoggingConfig", "type": "object", "properties": {} }, "GoogleIamV1AuditConfig": { "type": "object", "properties": { "auditLogConfigs": { "description": "The configuration for logging of each type of permission.", "items": { "$ref": "GoogleIamV1AuditLogConfig" }, "type": "array" }, "service": { "type": "string", "description": "Specifies a service that will be enabled for audit logging. For example, `storage.googleapis.com`, `cloudsql.googleapis.com`. `allServices` is a special value that covers all services." } }, "description": "Specifies the audit configuration for a service. The configuration determines which permission types are logged, and what identities, if any, are exempted from logging. An AuditConfig must have one or more AuditLogConfigs. If there are AuditConfigs for both `allServices` and a specific service, the union of the two AuditConfigs is used for that service: the log_types specified in each AuditConfig are enabled, and the exempted_members in each AuditLogConfig are exempted. Example Policy with multiple AuditConfigs: { \"audit_configs\": [ { \"service\": \"allServices\", \"audit_log_configs\": [ { \"log_type\": \"DATA_READ\", \"exempted_members\": [ \"user:jose@example.com\" ] }, { \"log_type\": \"DATA_WRITE\" }, { \"log_type\": \"ADMIN_READ\" } ] }, { \"service\": \"sampleservice.googleapis.com\", \"audit_log_configs\": [ { \"log_type\": \"DATA_READ\" }, { \"log_type\": \"DATA_WRITE\", \"exempted_members\": [ \"user:aliya@example.com\" ] } ] } ] } For sampleservice, this policy enables DATA_READ, DATA_WRITE and ADMIN_READ logging. It also exempts `jose@example.com` from DATA_READ logging, and `aliya@example.com` from DATA_WRITE logging.", "id": "GoogleIamV1AuditConfig" }, "GoogleCloudBeyondcorpSecuritygatewaysV1alphaSecurityGatewayOperationMetadata": { "type": "object", "properties": { "apiVersion": { "readOnly": true, "type": "string", "description": "Output only. API version used to start the operation." }, "createTime": { "description": "Output only. The time the operation was created.", "type": "string", "readOnly": true, "format": "google-datetime" }, "target": { "description": "Output only. Server-defined resource path for the target of the operation.", "readOnly": true, "type": "string" }, "verb": { "description": "Output only. Name of the verb executed by the operation.", "type": "string", "readOnly": true }, "statusMessage": { "description": "Output only. Human-readable status of the operation, if any.", "readOnly": true, "type": "string" }, "endTime": { "description": "Output only. The time the operation finished running.", "type": "string", "readOnly": true, "format": "google-datetime" }, "requestedCancellation": { "type": "boolean", "readOnly": true, "description": "Output only. Identifies whether the user has requested cancellation of the operation. Operations that have been cancelled successfully have Operation.error value with a google.rpc.Status.code of 1, corresponding to `Code.CANCELLED`." } }, "description": "Represents the metadata of the long-running operation.", "id": "GoogleCloudBeyondcorpSecuritygatewaysV1alphaSecurityGatewayOperationMetadata" }, "GoogleCloudBeyondcorpSecuritygatewaysV1ApplicationUpstreamNetwork": { "type": "object", "properties": { "name": { "type": "string", "description": "Required. Network name is of the format: `projects/{project}/global/networks/{network}" } }, "id": "GoogleCloudBeyondcorpSecuritygatewaysV1ApplicationUpstreamNetwork", "description": "Network to forward traffic to." }, "GoogleCloudBeyondcorpAppconnectorsV1ResourceInfo": { "id": "GoogleCloudBeyondcorpAppconnectorsV1ResourceInfo", "description": "ResourceInfo represents the information or status of an app connector resource component that's used to report on various parts of the system. For example, ResourceInfo can be used to convey the status of a remote_agent, including the status of an appgateway for an runtime environment in a container instance.", "type": "object", "properties": { "resource": { "description": "Specific details for the resource. This is for internal use only.", "type": "object", "additionalProperties": { "description": "Properties of the object. Contains field @type with type URL.", "type": "any" } }, "id": { "description": "Required. Unique Id for the resource.", "type": "string" }, "time": { "format": "google-datetime", "type": "string", "description": "The timestamp to collect the info. It is suggested to be set by the topmost level resource only." }, "status": { "description": "Overall health status. Overall status is derived based on the status of each sub level resources.", "enumDescriptions": [ "Health status is unknown: not initialized or failed to retrieve.", "The resource is healthy.", "The resource is unhealthy.", "The resource is unresponsive.", "Some sub-resources are UNHEALTHY." ], "type": "string", "enum": [ "HEALTH_STATUS_UNSPECIFIED", "HEALTHY", "UNHEALTHY", "UNRESPONSIVE", "DEGRADED" ] }, "sub": { "type": "array", "description": "List of Info for the sub level resources.", "items": { "$ref": "GoogleCloudBeyondcorpAppconnectorsV1ResourceInfo" } } } }, "GoogleCloudBeyondcorpConnectorsV1alphaConnectorOperationMetadata": { "type": "object", "properties": { "verb": { "readOnly": true, "type": "string", "description": "Output only. Name of the verb executed by the operation." }, "statusMessage": { "readOnly": true, "type": "string", "description": "Output only. Human-readable status of the operation, if any." }, "createTime": { "readOnly": true, "format": "google-datetime", "type": "string", "description": "Output only. The time the operation was created." }, "target": { "readOnly": true, "type": "string", "description": "Output only. Server-defined resource path for the target of the operation." }, "apiVersion": { "readOnly": true, "type": "string", "description": "Output only. API version used to start the operation." }, "requestedCancellation": { "type": "boolean", "readOnly": true, "description": "Output only. Identifies whether the user has requested cancellation of the operation. Operations that have successfully been cancelled have Operation.error value with a google.rpc.Status.code of 1, corresponding to `Code.CANCELLED`." }, "endTime": { "description": "Output only. The time the operation finished running.", "type": "string", "readOnly": true, "format": "google-datetime" } }, "description": "Represents the metadata of the long-running operation.", "id": "GoogleCloudBeyondcorpConnectorsV1alphaConnectorOperationMetadata" }, "GoogleCloudBeyondcorpAppconnectorsV1AppConnector": { "type": "object", "properties": { "uid": { "readOnly": true, "type": "string", "description": "Output only. A unique identifier for the instance generated by the system." }, "name": { "type": "string", "description": "Required. Unique resource name of the AppConnector. The name is ignored when creating a AppConnector." }, "updateTime": { "type": "string", "readOnly": true, "format": "google-datetime", "description": "Output only. Timestamp when the resource was last modified." }, "principalInfo": { "description": "Required. Principal information about the Identity of the AppConnector.", "$ref": "GoogleCloudBeyondcorpAppconnectorsV1AppConnectorPrincipalInfo" }, "state": { "readOnly": true, "enum": [ "STATE_UNSPECIFIED", "CREATING", "CREATED", "UPDATING", "DELETING", "DOWN" ], "description": "Output only. The current state of the AppConnector.", "enumDescriptions": [ "Default value. This value is unused.", "AppConnector is being created.", "AppConnector has been created.", "AppConnector's configuration is being updated.", "AppConnector is being deleted.", "AppConnector is down and may be restored in the future. This happens when CCFE sends ProjectState = OFF." ], "type": "string" }, "labels": { "type": "object", "additionalProperties": { "type": "string" }, "description": "Optional. Resource labels to represent user provided metadata." }, "createTime": { "description": "Output only. Timestamp when the resource was created.", "type": "string", "readOnly": true, "format": "google-datetime" }, "displayName": { "description": "Optional. An arbitrary user-provided name for the AppConnector. Cannot exceed 64 characters.", "type": "string" }, "resourceInfo": { "description": "Optional. Resource info of the connector.", "$ref": "GoogleCloudBeyondcorpAppconnectorsV1ResourceInfo" } }, "id": "GoogleCloudBeyondcorpAppconnectorsV1AppConnector", "description": "A BeyondCorp connector resource that represents an application facing component deployed proximal to and with direct access to the application instances. It is used to establish connectivity between the remote enterprise environment and GCP. It initiates connections to the applications and can proxy the data from users over the connection." }, "ListAppGatewaysResponse": { "type": "object", "properties": { "unreachable": { "description": "A list of locations that could not be reached.", "items": { "type": "string" }, "type": "array" }, "appGateways": { "description": "A list of BeyondCorp AppGateways in the project.", "items": { "$ref": "AppGateway" }, "type": "array" }, "nextPageToken": { "description": "A token to retrieve the next page of results, or empty if there are no more results in the list.", "type": "string" } }, "description": "Response message for BeyondCorp.ListAppGateways.", "id": "ListAppGatewaysResponse" }, "GoogleCloudBeyondcorpSecuritygatewaysV1SecurityGatewayOperationMetadata": { "type": "object", "properties": { "requestedCancellation": { "readOnly": true, "type": "boolean", "description": "Output only. Identifies whether the user has requested cancellation of the operation. Operations that have been cancelled successfully have Operation.error value with a google.rpc.Status.code of 1, corresponding to `Code.CANCELLED`." }, "endTime": { "readOnly": true, "format": "google-datetime", "type": "string", "description": "Output only. The time the operation finished running." }, "verb": { "type": "string", "readOnly": true, "description": "Output only. Name of the verb executed by the operation." }, "statusMessage": { "type": "string", "readOnly": true, "description": "Output only. Human-readable status of the operation, if any." }, "createTime": { "type": "string", "readOnly": true, "format": "google-datetime", "description": "Output only. The time the operation was created." }, "target": { "readOnly": true, "type": "string", "description": "Output only. Server-defined resource path for the target of the operation." }, "apiVersion": { "description": "Output only. API version used to start the operation.", "type": "string", "readOnly": true } }, "id": "GoogleCloudBeyondcorpSecuritygatewaysV1SecurityGatewayOperationMetadata", "description": "Represents the metadata of the long-running operation." }, "GoogleIamV1Policy": { "id": "GoogleIamV1Policy", "description": "An Identity and Access Management (IAM) policy, which specifies access controls for Google Cloud resources. A `Policy` is a collection of `bindings`. A `binding` binds one or more `members`, or principals, to a single `role`. Principals can be user accounts, service accounts, Google groups, and domains (such as G Suite). A `role` is a named list of permissions; each `role` can be an IAM predefined role or a user-created custom role. For some types of Google Cloud resources, a `binding` can also specify a `condition`, which is a logical expression that allows access to a resource only if the expression evaluates to `true`. A condition can add constraints based on attributes of the request, the resource, or both. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies). **JSON example:** ``` { \"bindings\": [ { \"role\": \"roles/resourcemanager.organizationAdmin\", \"members\": [ \"user:mike@example.com\", \"group:admins@example.com\", \"domain:google.com\", \"serviceAccount:my-project-id@appspot.gserviceaccount.com\" ] }, { \"role\": \"roles/resourcemanager.organizationViewer\", \"members\": [ \"user:eve@example.com\" ], \"condition\": { \"title\": \"expirable access\", \"description\": \"Does not grant access after Sep 2020\", \"expression\": \"request.time \u003c timestamp('2020-10-01T00:00:00.000Z')\", } } ], \"etag\": \"BwWWja0YfJA=\", \"version\": 3 } ``` **YAML example:** ``` bindings: - members: - user:mike@example.com - group:admins@example.com - domain:google.com - serviceAccount:my-project-id@appspot.gserviceaccount.com role: roles/resourcemanager.organizationAdmin - members: - user:eve@example.com role: roles/resourcemanager.organizationViewer condition: title: expirable access description: Does not grant access after Sep 2020 expression: request.time \u003c timestamp('2020-10-01T00:00:00.000Z') etag: BwWWja0YfJA= version: 3 ``` For a description of IAM and its features, see the [IAM documentation](https://cloud.google.com/iam/docs/).", "type": "object", "properties": { "version": { "description": "Specifies the format of the policy. Valid values are `0`, `1`, and `3`. Requests that specify an invalid value are rejected. Any operation that affects conditional role bindings must specify version `3`. This requirement applies to the following operations: * Getting a policy that includes a conditional role binding * Adding a conditional role binding to a policy * Changing a conditional role binding in a policy * Removing any role binding, with or without a condition, from a policy that includes conditions **Important:** If you use IAM Conditions, you must include the `etag` field whenever you call `setIamPolicy`. If you omit this field, then IAM allows you to overwrite a version `3` policy with a version `1` policy, and all of the conditions in the version `3` policy are lost. If a policy does not include any conditions, operations on that policy may specify any valid version or leave the field unset. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies).", "type": "integer", "format": "int32" }, "bindings": { "description": "Associates a list of `members`, or principals, with a `role`. Optionally, may specify a `condition` that determines how and when the `bindings` are applied. Each of the `bindings` must contain at least one principal. The `bindings` in a `Policy` can refer to up to 1,500 principals; up to 250 of these principals can be Google groups. Each occurrence of a principal counts towards these limits. For example, if the `bindings` grant 50 different roles to `user:alice@example.com`, and not to any other principal, then you can add another 1,450 principals to the `bindings` in the `Policy`.", "items": { "$ref": "GoogleIamV1Binding" }, "type": "array" }, "etag": { "format": "byte", "type": "string", "description": "`etag` is used for optimistic concurrency control as a way to help prevent simultaneous updates of a policy from overwriting each other. It is strongly suggested that systems make use of the `etag` in the read-modify-write cycle to perform policy updates in order to avoid race conditions: An `etag` is returned in the response to `getIamPolicy`, and systems are expected to put that etag in the request to `setIamPolicy` to ensure that their change will be applied to the same version of the policy. **Important:** If you use IAM Conditions, you must include the `etag` field whenever you call `setIamPolicy`. If you omit this field, then IAM allows you to overwrite a version `3` policy with a version `1` policy, and all of the conditions in the version `3` policy are lost." }, "auditConfigs": { "type": "array", "description": "Specifies cloud audit logging configuration for this policy.", "items": { "$ref": "GoogleIamV1AuditConfig" } } } }, "GoogleIamV1TestIamPermissionsResponse": { "type": "object", "properties": { "permissions": { "type": "array", "description": "A subset of `TestPermissionsRequest.permissions` that the caller is allowed.", "items": { "type": "string" } } }, "id": "GoogleIamV1TestIamPermissionsResponse", "description": "Response message for `TestIamPermissions` method." }, "Tunnelv1ProtoTunnelerError": { "type": "object", "properties": { "retryable": { "description": "retryable isn't used for now, but we may want to reuse it in the future.", "type": "boolean" }, "err": { "description": "Original raw error", "type": "string" } }, "id": "Tunnelv1ProtoTunnelerError", "description": "TunnelerError is an error proto for errors returned by the connection manager." } }, "fullyEncodeReservedExpansion": true, "id": "beyondcorp:v1", "ownerDomain": "google.com", "protocol": "rest", "ownerName": "Google", "version_module": true, "batchPath": "batch", "servicePath": "", "baseUrl": "https://beyondcorp.googleapis.com/", "basePath": "", "mtlsRootUrl": "https://beyondcorp.mtls.googleapis.com/", "revision": "20260429", "version": "v1", "kind": "discovery#restDescription", "name": "beyondcorp", "auth": { "oauth2": { "scopes": { "https://www.googleapis.com/auth/cloud-platform": { "description": "See, edit, configure, and delete your Google Cloud data and see the email address for your Google Account." } } } }, "title": "BeyondCorp API", "resources": { "organizations": { "resources": { "locations": { "resources": { "operations": { "methods": { "get": { "parameters": { "name": { "description": "The name of the operation resource.", "location": "path", "required": true, "pattern": "^organizations/[^/]+/locations/[^/]+/operations/[^/]+$", "type": "string" } }, "path": "v1/{+name}", "description": "Gets the latest state of a long-running operation. Clients can use this method to poll the operation result at intervals as recommended by the API service.", "flatPath": "v1/organizations/{organizationsId}/locations/{locationsId}/operations/{operationsId}", "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "id": "beyondcorp.organizations.locations.operations.get", "httpMethod": "GET", "parameterOrder": [ "name" ], "response": { "$ref": "GoogleLongrunningOperation" } }, "cancel": { "flatPath": "v1/organizations/{organizationsId}/locations/{locationsId}/operations/{operationsId}:cancel", "path": "v1/{+name}:cancel", "request": { "$ref": "GoogleLongrunningCancelOperationRequest" }, "description": "Starts asynchronous cancellation on a long-running operation. The server makes a best effort to cancel the operation, but success is not guaranteed. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Clients can use Operations.GetOperation or other methods to check whether the cancellation succeeded or whether the operation completed despite cancellation. On successful cancellation, the operation is not deleted; instead, it becomes an operation with an Operation.error value with a google.rpc.Status.code of `1`, corresponding to `Code.CANCELLED`.", "parameters": { "name": { "type": "string", "pattern": "^organizations/[^/]+/locations/[^/]+/operations/[^/]+$", "required": true, "location": "path", "description": "The name of the operation resource to be cancelled." } }, "id": "beyondcorp.organizations.locations.operations.cancel", "httpMethod": "POST", "parameterOrder": [ "name" ], "response": { "$ref": "Empty" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ] }, "delete": { "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "id": "beyondcorp.organizations.locations.operations.delete", "httpMethod": "DELETE", "parameterOrder": [ "name" ], "response": { "$ref": "Empty" }, "parameters": { "name": { "required": true, "pattern": "^organizations/[^/]+/locations/[^/]+/operations/[^/]+$", "type": "string", "description": "The name of the operation resource to be deleted.", "location": "path" } }, "flatPath": "v1/organizations/{organizationsId}/locations/{locationsId}/operations/{operationsId}", "path": "v1/{+name}", "description": "Deletes a long-running operation. This method indicates that the client is no longer interested in the operation result. It does not cancel the operation. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`." }, "list": { "parameters": { "pageToken": { "description": "The standard list page token.", "type": "string", "location": "query" }, "returnPartialSuccess": { "description": "When set to `true`, operations that are reachable are returned as normal, and those that are unreachable are returned in the ListOperationsResponse.unreachable field. This can only be `true` when reading across collections. For example, when `parent` is set to `\"projects/example/locations/-\"`. This field is not supported by default and will result in an `UNIMPLEMENTED` error if set unless explicitly documented otherwise in service or product specific documentation.", "location": "query", "type": "boolean" }, "name": { "description": "The name of the operation's parent resource.", "location": "path", "required": true, "type": "string", "pattern": "^organizations/[^/]+/locations/[^/]+$" }, "pageSize": { "location": "query", "format": "int32", "type": "integer", "description": "The standard list page size." }, "filter": { "location": "query", "type": "string", "description": "The standard list filter." } }, "flatPath": "v1/organizations/{organizationsId}/locations/{locationsId}/operations", "path": "v1/{+name}/operations", "description": "Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`.", "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "id": "beyondcorp.organizations.locations.operations.list", "httpMethod": "GET", "parameterOrder": [ "name" ], "response": { "$ref": "GoogleLongrunningListOperationsResponse" } } } } } } } }, "projects": { "resources": { "locations": { "methods": { "list": { "parameters": { "name": { "location": "path", "description": "The resource that owns the locations collection, if applicable.", "type": "string", "pattern": "^projects/[^/]+$", "required": true }, "pageSize": { "type": "integer", "location": "query", "format": "int32", "description": "The maximum number of results to return. If not set, the service selects a default." }, "extraLocationTypes": { "location": "query", "type": "string", "description": "Optional. Do not use this field unless explicitly documented otherwise. This is primarily for internal usage.", "repeated": true }, "filter": { "description": "A filter to narrow down results to a preferred subset. The filtering language accepts strings like `\"displayName=tokyo\"`, and is documented in more detail in [AIP-160](https://google.aip.dev/160).", "type": "string", "location": "query" }, "pageToken": { "location": "query", "type": "string", "description": "A page token received from the `next_page_token` field in the response. Send that page token to receive the subsequent page." } }, "path": "v1/{+name}/locations", "description": "Lists information about the supported locations for this service. This method lists locations based on the resource scope provided in the ListLocationsRequest.name field: * **Global locations**: If `name` is empty, the method lists the public locations available to all projects. * **Project-specific locations**: If `name` follows the format `projects/{project}`, the method lists locations visible to that specific project. This includes public, private, or other project-specific locations enabled for the project. For gRPC and client library implementations, the resource name is passed as the `name` field. For direct service calls, the resource name is incorporated into the request path based on the specific service implementation and version.", "flatPath": "v1/projects/{projectsId}/locations", "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "id": "beyondcorp.projects.locations.list", "httpMethod": "GET", "parameterOrder": [ "name" ], "response": { "$ref": "GoogleCloudLocationListLocationsResponse" } }, "get": { "id": "beyondcorp.projects.locations.get", "httpMethod": "GET", "parameterOrder": [ "name" ], "response": { "$ref": "GoogleCloudLocationLocation" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "path": "v1/{+name}", "description": "Gets information about a location.", "flatPath": "v1/projects/{projectsId}/locations/{locationsId}", "parameters": { "name": { "required": true, "pattern": "^projects/[^/]+/locations/[^/]+$", "type": "string", "description": "Resource name for the location.", "location": "path" } } } }, "resources": { "operations": { "methods": { "list": { "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/operations", "description": "Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`.", "path": "v1/{+name}/operations", "parameters": { "pageToken": { "description": "The standard list page token.", "type": "string", "location": "query" }, "returnPartialSuccess": { "description": "When set to `true`, operations that are reachable are returned as normal, and those that are unreachable are returned in the ListOperationsResponse.unreachable field. This can only be `true` when reading across collections. For example, when `parent` is set to `\"projects/example/locations/-\"`. This field is not supported by default and will result in an `UNIMPLEMENTED` error if set unless explicitly documented otherwise in service or product specific documentation.", "location": "query", "type": "boolean" }, "name": { "location": "path", "description": "The name of the operation's parent resource.", "type": "string", "pattern": "^projects/[^/]+/locations/[^/]+$", "required": true }, "pageSize": { "description": "The standard list page size.", "type": "integer", "location": "query", "format": "int32" }, "filter": { "type": "string", "location": "query", "description": "The standard list filter." } }, "httpMethod": "GET", "parameterOrder": [ "name" ], "response": { "$ref": "GoogleLongrunningListOperationsResponse" }, "id": "beyondcorp.projects.locations.operations.list", "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ] }, "get": { "httpMethod": "GET", "parameterOrder": [ "name" ], "response": { "$ref": "GoogleLongrunningOperation" }, "id": "beyondcorp.projects.locations.operations.get", "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "description": "Gets the latest state of a long-running operation. Clients can use this method to poll the operation result at intervals as recommended by the API service.", "path": "v1/{+name}", "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/operations/{operationsId}", "parameters": { "name": { "pattern": "^projects/[^/]+/locations/[^/]+/operations/[^/]+$", "type": "string", "required": true, "location": "path", "description": "The name of the operation resource." } } }, "cancel": { "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "id": "beyondcorp.projects.locations.operations.cancel", "httpMethod": "POST", "parameterOrder": [ "name" ], "response": { "$ref": "Empty" }, "parameters": { "name": { "description": "The name of the operation resource to be cancelled.", "location": "path", "required": true, "type": "string", "pattern": "^projects/[^/]+/locations/[^/]+/operations/[^/]+$" } }, "path": "v1/{+name}:cancel", "request": { "$ref": "GoogleLongrunningCancelOperationRequest" }, "description": "Starts asynchronous cancellation on a long-running operation. The server makes a best effort to cancel the operation, but success is not guaranteed. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Clients can use Operations.GetOperation or other methods to check whether the cancellation succeeded or whether the operation completed despite cancellation. On successful cancellation, the operation is not deleted; instead, it becomes an operation with an Operation.error value with a google.rpc.Status.code of `1`, corresponding to `Code.CANCELLED`.", "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/operations/{operationsId}:cancel" }, "delete": { "description": "Deletes a long-running operation. This method indicates that the client is no longer interested in the operation result. It does not cancel the operation. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`.", "path": "v1/{+name}", "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/operations/{operationsId}", "parameters": { "name": { "type": "string", "pattern": "^projects/[^/]+/locations/[^/]+/operations/[^/]+$", "required": true, "location": "path", "description": "The name of the operation resource to be deleted." } }, "httpMethod": "DELETE", "parameterOrder": [ "name" ], "response": { "$ref": "Empty" }, "id": "beyondcorp.projects.locations.operations.delete", "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ] } } }, "appConnections": { "methods": { "testIamPermissions": { "parameters": { "resource": { "location": "path", "description": "REQUIRED: The resource for which the policy detail is being requested. See [Resource names](https://cloud.google.com/apis/design/resource_names) for the appropriate value for this field.", "pattern": "^projects/[^/]+/locations/[^/]+/appConnections/[^/]+$", "type": "string", "required": true } }, "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/appConnections/{appConnectionsId}:testIamPermissions", "path": "v1/{+resource}:testIamPermissions", "request": { "$ref": "GoogleIamV1TestIamPermissionsRequest" }, "description": "Returns permissions that a caller has on the specified resource. If the resource does not exist, this will return an empty set of permissions, not a `NOT_FOUND` error. Note: This operation is designed to be used for building permission-aware UIs and command-line tools, not for authorization checking. This operation may \"fail open\" without warning.", "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "id": "beyondcorp.projects.locations.appConnections.testIamPermissions", "httpMethod": "POST", "parameterOrder": [ "resource" ], "response": { "$ref": "GoogleIamV1TestIamPermissionsResponse" } }, "delete": { "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "id": "beyondcorp.projects.locations.appConnections.delete", "httpMethod": "DELETE", "parameterOrder": [ "name" ], "response": { "$ref": "GoogleLongrunningOperation" }, "parameters": { "requestId": { "description": "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 the 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).", "location": "query", "type": "string" }, "validateOnly": { "description": "Optional. If set, validates request by executing a dry-run which would not alter the resource in any way.", "location": "query", "type": "boolean" }, "name": { "description": "Required. BeyondCorp Connector name using the form: `projects/{project_id}/locations/{location_id}/appConnections/{app_connection_id}`", "location": "path", "required": true, "pattern": "^projects/[^/]+/locations/[^/]+/appConnections/[^/]+$", "type": "string" } }, "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/appConnections/{appConnectionsId}", "path": "v1/{+name}", "description": "Deletes a single AppConnection." }, "get": { "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "id": "beyondcorp.projects.locations.appConnections.get", "httpMethod": "GET", "parameterOrder": [ "name" ], "response": { "$ref": "GoogleCloudBeyondcorpAppconnectionsV1AppConnection" }, "parameters": { "name": { "location": "path", "description": "Required. BeyondCorp AppConnection name using the form: `projects/{project_id}/locations/{location_id}/appConnections/{app_connection_id}`", "type": "string", "pattern": "^projects/[^/]+/locations/[^/]+/appConnections/[^/]+$", "required": true } }, "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/appConnections/{appConnectionsId}", "path": "v1/{+name}", "description": "Gets details of a single AppConnection." }, "resolve": { "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "httpMethod": "GET", "parameterOrder": [ "parent" ], "response": { "$ref": "GoogleCloudBeyondcorpAppconnectionsV1ResolveAppConnectionsResponse" }, "id": "beyondcorp.projects.locations.appConnections.resolve", "parameters": { "pageToken": { "location": "query", "type": "string", "description": "Optional. The next_page_token value returned from a previous ResolveAppConnectionsResponse, if any." }, "pageSize": { "description": "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.", "location": "query", "format": "int32", "type": "integer" }, "parent": { "pattern": "^projects/[^/]+/locations/[^/]+$", "type": "string", "required": true, "location": "path", "description": "Required. The resource name of the AppConnection location using the form: `projects/{project_id}/locations/{location_id}`" }, "appConnectorId": { "type": "string", "location": "query", "description": "Required. BeyondCorp Connector name of the connector associated with those AppConnections using the form: `projects/{project_id}/locations/{location_id}/appConnectors/{app_connector_id}`" } }, "description": "Resolves AppConnections details for a given AppConnector. An internal method called by a connector to find AppConnections to connect to.", "path": "v1/{+parent}/appConnections:resolve", "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/appConnections:resolve" }, "patch": { "parameters": { "validateOnly": { "description": "Optional. If set, validates request by executing a dry-run which would not alter the resource in any way.", "type": "boolean", "location": "query" }, "allowMissing": { "location": "query", "type": "boolean", "description": "Optional. If set as true, will create the resource if it is not found." }, "name": { "required": true, "type": "string", "pattern": "^projects/[^/]+/locations/[^/]+/appConnections/[^/]+$", "description": "Required. Unique resource name of the AppConnection. The name is ignored when creating a AppConnection.", "location": "path" }, "requestId": { "description": "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 the 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).", "type": "string", "location": "query" }, "updateMask": { "type": "string", "location": "query", "format": "google-fieldmask", "description": "Required. Mask of fields to update. At least one path must be supplied in this field. The elements of the repeated paths field may only include these fields from [BeyondCorp.AppConnection]: * `labels` * `display_name` * `application_endpoint` * `connectors`" } }, "path": "v1/{+name}", "request": { "$ref": "GoogleCloudBeyondcorpAppconnectionsV1AppConnection" }, "description": "Updates the parameters of a single AppConnection.", "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/appConnections/{appConnectionsId}", "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "id": "beyondcorp.projects.locations.appConnections.patch", "httpMethod": "PATCH", "parameterOrder": [ "name" ], "response": { "$ref": "GoogleLongrunningOperation" } }, "create": { "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "httpMethod": "POST", "parameterOrder": [ "parent" ], "response": { "$ref": "GoogleLongrunningOperation" }, "id": "beyondcorp.projects.locations.appConnections.create", "parameters": { "appConnectionId": { "description": "Optional. User-settable AppConnection resource ID. * Must start with a letter. * Must contain between 4-63 characters from `/a-z-/`. * Must end with a number or a letter.", "type": "string", "location": "query" }, "validateOnly": { "description": "Optional. If set, validates request by executing a dry-run which would not alter the resource in any way.", "type": "boolean", "location": "query" }, "requestId": { "description": "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 the 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).", "location": "query", "type": "string" }, "parent": { "required": true, "type": "string", "pattern": "^projects/[^/]+/locations/[^/]+$", "description": "Required. The resource project name of the AppConnection location using the form: `projects/{project_id}/locations/{location_id}`", "location": "path" } }, "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/appConnections", "description": "Creates a new AppConnection in a given project and location.", "path": "v1/{+parent}/appConnections", "request": { "$ref": "GoogleCloudBeyondcorpAppconnectionsV1AppConnection" } }, "setIamPolicy": { "parameters": { "resource": { "pattern": "^projects/[^/]+/locations/[^/]+/appConnections/[^/]+$", "type": "string", "required": true, "location": "path", "description": "REQUIRED: The resource for which the policy is being specified. See [Resource names](https://cloud.google.com/apis/design/resource_names) for the appropriate value for this field." } }, "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/appConnections/{appConnectionsId}:setIamPolicy", "path": "v1/{+resource}:setIamPolicy", "request": { "$ref": "GoogleIamV1SetIamPolicyRequest" }, "description": "Sets the access control policy on the specified resource. Replaces any existing policy. Can return `NOT_FOUND`, `INVALID_ARGUMENT`, and `PERMISSION_DENIED` errors.", "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "id": "beyondcorp.projects.locations.appConnections.setIamPolicy", "httpMethod": "POST", "parameterOrder": [ "resource" ], "response": { "$ref": "GoogleIamV1Policy" } }, "list": { "parameters": { "parent": { "pattern": "^projects/[^/]+/locations/[^/]+$", "type": "string", "required": true, "location": "path", "description": "Required. The resource name of the AppConnection location using the form: `projects/{project_id}/locations/{location_id}`" }, "filter": { "description": "Optional. A filter specifying constraints of a list operation.", "type": "string", "location": "query" }, "pageSize": { "description": "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.", "location": "query", "format": "int32", "type": "integer" }, "pageToken": { "description": "Optional. The next_page_token value returned from a previous ListAppConnectionsRequest, if any.", "location": "query", "type": "string" }, "orderBy": { "description": "Optional. Specifies the ordering of results. See [Sorting order](https://cloud.google.com/apis/design/design_patterns#sorting_order) for more information.", "location": "query", "type": "string" } }, "description": "Lists AppConnections in a given project and location.", "path": "v1/{+parent}/appConnections", "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/appConnections", "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "httpMethod": "GET", "parameterOrder": [ "parent" ], "response": { "$ref": "GoogleCloudBeyondcorpAppconnectionsV1ListAppConnectionsResponse" }, "id": "beyondcorp.projects.locations.appConnections.list" }, "getIamPolicy": { "parameters": { "resource": { "description": "REQUIRED: The resource for which the policy is being requested. See [Resource names](https://cloud.google.com/apis/design/resource_names) for the appropriate value for this field.", "location": "path", "required": true, "type": "string", "pattern": "^projects/[^/]+/locations/[^/]+/appConnections/[^/]+$" }, "options.requestedPolicyVersion": { "type": "integer", "location": "query", "format": "int32", "description": "Optional. The maximum policy version that will be used to format the policy. Valid values are 0, 1, and 3. Requests specifying an invalid value will be rejected. Requests for policies with any conditional role bindings must specify version 3. Policies with no conditional role bindings may specify any valid value or leave the field unset. The policy in the response might use the policy version that you specified, or it might use a lower policy version. For example, if you specify version 3, but the policy has no conditional role bindings, the response uses version 1. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies)." } }, "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/appConnections/{appConnectionsId}:getIamPolicy", "path": "v1/{+resource}:getIamPolicy", "description": "Gets the access control policy for a resource. Returns an empty policy if the resource exists and does not have a policy set.", "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "id": "beyondcorp.projects.locations.appConnections.getIamPolicy", "httpMethod": "GET", "parameterOrder": [ "resource" ], "response": { "$ref": "GoogleIamV1Policy" } } } }, "securityGateways": { "methods": { "testIamPermissions": { "description": "Returns permissions that a caller has on the specified resource. If the resource does not exist, this will return an empty set of permissions, not a `NOT_FOUND` error. Note: This operation is designed to be used for building permission-aware UIs and command-line tools, not for authorization checking. This operation may \"fail open\" without warning.", "path": "v1/{+resource}:testIamPermissions", "request": { "$ref": "GoogleIamV1TestIamPermissionsRequest" }, "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/securityGateways/{securityGatewaysId}:testIamPermissions", "parameters": { "resource": { "required": true, "pattern": "^projects/[^/]+/locations/[^/]+/securityGateways/[^/]+$", "type": "string", "description": "REQUIRED: The resource for which the policy detail is being requested. See [Resource names](https://cloud.google.com/apis/design/resource_names) for the appropriate value for this field.", "location": "path" } }, "httpMethod": "POST", "parameterOrder": [ "resource" ], "response": { "$ref": "GoogleIamV1TestIamPermissionsResponse" }, "id": "beyondcorp.projects.locations.securityGateways.testIamPermissions", "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ] }, "patch": { "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/securityGateways/{securityGatewaysId}", "description": "Updates the parameters of a single SecurityGateway.", "path": "v1/{+name}", "request": { "$ref": "GoogleCloudBeyondcorpSecuritygatewaysV1SecurityGateway" }, "parameters": { "requestId": { "location": "query", "type": "string", "description": "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)." }, "name": { "required": true, "pattern": "^projects/[^/]+/locations/[^/]+/securityGateways/[^/]+$", "type": "string", "description": "Identifier. Name of the resource.", "location": "path" }, "updateMask": { "description": "Optional. Mutable fields include: display_name, hubs.", "location": "query", "format": "google-fieldmask", "type": "string" } }, "httpMethod": "PATCH", "parameterOrder": [ "name" ], "response": { "$ref": "GoogleLongrunningOperation" }, "id": "beyondcorp.projects.locations.securityGateways.patch", "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ] }, "get": { "id": "beyondcorp.projects.locations.securityGateways.get", "httpMethod": "GET", "parameterOrder": [ "name" ], "response": { "$ref": "GoogleCloudBeyondcorpSecuritygatewaysV1SecurityGateway" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "path": "v1/{+name}", "description": "Gets details of a single SecurityGateway.", "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/securityGateways/{securityGatewaysId}", "parameters": { "name": { "location": "path", "description": "Required. The resource name of the PartnerTenant using the form: `projects/{project_id}/locations/{location_id}/securityGateway/{security_gateway_id}`", "pattern": "^projects/[^/]+/locations/[^/]+/securityGateways/[^/]+$", "type": "string", "required": true } } }, "create": { "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "httpMethod": "POST", "parameterOrder": [ "parent" ], "response": { "$ref": "GoogleLongrunningOperation" }, "id": "beyondcorp.projects.locations.securityGateways.create", "parameters": { "securityGatewayId": { "description": "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.", "type": "string", "location": "query" }, "requestId": { "description": "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.", "location": "query", "type": "string" }, "parent": { "pattern": "^projects/[^/]+/locations/[^/]+$", "type": "string", "required": true, "location": "path", "description": "Required. The resource project name of the SecurityGateway location using the form: `projects/{project_id}/locations/{location_id}`" } }, "description": "Creates a new Security Gateway in a given project and location.", "path": "v1/{+parent}/securityGateways", "request": { "$ref": "GoogleCloudBeyondcorpSecuritygatewaysV1SecurityGateway" }, "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/securityGateways" }, "delete": { "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/securityGateways/{securityGatewaysId}", "path": "v1/{+name}", "description": "Deletes a single SecurityGateway.", "parameters": { "name": { "type": "string", "pattern": "^projects/[^/]+/locations/[^/]+/securityGateways/[^/]+$", "required": true, "location": "path", "description": "Required. BeyondCorp SecurityGateway name using the form: `projects/{project_id}/locations/{location_id}/securityGateways/{security_gateway_id}`" }, "validateOnly": { "description": "Optional. If set, validates request by executing a dry-run which would not alter the resource in any way.", "type": "boolean", "location": "query" }, "requestId": { "type": "string", "location": "query", "description": "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)." } }, "id": "beyondcorp.projects.locations.securityGateways.delete", "httpMethod": "DELETE", "parameterOrder": [ "name" ], "response": { "$ref": "GoogleLongrunningOperation" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ] }, "list": { "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "httpMethod": "GET", "parameterOrder": [ "parent" ], "response": { "$ref": "GoogleCloudBeyondcorpSecuritygatewaysV1ListSecurityGatewaysResponse" }, "id": "beyondcorp.projects.locations.securityGateways.list", "parameters": { "parent": { "description": "Required. The parent location to which the resources belong. `projects/{project_id}/locations/{location_id}/`", "location": "path", "required": true, "type": "string", "pattern": "^projects/[^/]+/locations/[^/]+$" }, "filter": { "type": "string", "location": "query", "description": "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." }, "pageSize": { "description": "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.", "type": "integer", "location": "query", "format": "int32" }, "pageToken": { "description": "Optional. The next_page_token value returned from a previous ListSecurityGatewayRequest, if any.", "type": "string", "location": "query" }, "orderBy": { "location": "query", "type": "string", "description": "Optional. Specifies the ordering of results. See [Sorting order](https://cloud.google.com/apis/design/design_patterns#sorting_order) for more information." } }, "description": "Lists SecurityGateways in a given project and location.", "path": "v1/{+parent}/securityGateways", "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/securityGateways" }, "getIamPolicy": { "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/securityGateways/{securityGatewaysId}:getIamPolicy", "description": "Gets the access control policy for a resource. Returns an empty policy if the resource exists and does not have a policy set.", "path": "v1/{+resource}:getIamPolicy", "parameters": { "resource": { "description": "REQUIRED: The resource for which the policy is being requested. See [Resource names](https://cloud.google.com/apis/design/resource_names) for the appropriate value for this field.", "location": "path", "required": true, "type": "string", "pattern": "^projects/[^/]+/locations/[^/]+/securityGateways/[^/]+$" }, "options.requestedPolicyVersion": { "type": "integer", "location": "query", "format": "int32", "description": "Optional. The maximum policy version that will be used to format the policy. Valid values are 0, 1, and 3. Requests specifying an invalid value will be rejected. Requests for policies with any conditional role bindings must specify version 3. Policies with no conditional role bindings may specify any valid value or leave the field unset. The policy in the response might use the policy version that you specified, or it might use a lower policy version. For example, if you specify version 3, but the policy has no conditional role bindings, the response uses version 1. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies)." } }, "httpMethod": "GET", "parameterOrder": [ "resource" ], "response": { "$ref": "GoogleIamV1Policy" }, "id": "beyondcorp.projects.locations.securityGateways.getIamPolicy", "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ] }, "setIamPolicy": { "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "httpMethod": "POST", "parameterOrder": [ "resource" ], "response": { "$ref": "GoogleIamV1Policy" }, "id": "beyondcorp.projects.locations.securityGateways.setIamPolicy", "parameters": { "resource": { "description": "REQUIRED: The resource for which the policy is being specified. See [Resource names](https://cloud.google.com/apis/design/resource_names) for the appropriate value for this field.", "location": "path", "required": true, "pattern": "^projects/[^/]+/locations/[^/]+/securityGateways/[^/]+$", "type": "string" } }, "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/securityGateways/{securityGatewaysId}:setIamPolicy", "description": "Sets the access control policy on the specified resource. Replaces any existing policy. Can return `NOT_FOUND`, `INVALID_ARGUMENT`, and `PERMISSION_DENIED` errors.", "path": "v1/{+resource}:setIamPolicy", "request": { "$ref": "GoogleIamV1SetIamPolicyRequest" } } }, "resources": { "applications": { "methods": { "patch": { "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "id": "beyondcorp.projects.locations.securityGateways.applications.patch", "httpMethod": "PATCH", "parameterOrder": [ "name" ], "response": { "$ref": "GoogleLongrunningOperation" }, "parameters": { "name": { "pattern": "^projects/[^/]+/locations/[^/]+/securityGateways/[^/]+/applications/[^/]+$", "type": "string", "required": true, "location": "path", "description": "Identifier. Name of the resource." }, "updateMask": { "type": "string", "location": "query", "format": "google-fieldmask", "description": "Optional. Mutable fields include: display_name." }, "requestId": { "type": "string", "location": "query", "description": "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)." } }, "path": "v1/{+name}", "request": { "$ref": "GoogleCloudBeyondcorpSecuritygatewaysV1Application" }, "description": "Updates the parameters of a single Application.", "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/securityGateways/{securityGatewaysId}/applications/{applicationsId}" }, "testIamPermissions": { "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "httpMethod": "POST", "parameterOrder": [ "resource" ], "response": { "$ref": "GoogleIamV1TestIamPermissionsResponse" }, "id": "beyondcorp.projects.locations.securityGateways.applications.testIamPermissions", "parameters": { "resource": { "location": "path", "description": "REQUIRED: The resource for which the policy detail is being requested. See [Resource names](https://cloud.google.com/apis/design/resource_names) for the appropriate value for this field.", "pattern": "^projects/[^/]+/locations/[^/]+/securityGateways/[^/]+/applications/[^/]+$", "type": "string", "required": true } }, "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/securityGateways/{securityGatewaysId}/applications/{applicationsId}:testIamPermissions", "description": "Returns permissions that a caller has on the specified resource. If the resource does not exist, this will return an empty set of permissions, not a `NOT_FOUND` error. Note: This operation is designed to be used for building permission-aware UIs and command-line tools, not for authorization checking. This operation may \"fail open\" without warning.", "path": "v1/{+resource}:testIamPermissions", "request": { "$ref": "GoogleIamV1TestIamPermissionsRequest" } }, "delete": { "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "httpMethod": "DELETE", "parameterOrder": [ "name" ], "response": { "$ref": "GoogleLongrunningOperation" }, "id": "beyondcorp.projects.locations.securityGateways.applications.delete", "parameters": { "validateOnly": { "type": "boolean", "location": "query", "description": "Optional. If set, validates request by executing a dry-run which would not alter the resource in any way." }, "requestId": { "description": "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).", "location": "query", "type": "string" }, "name": { "location": "path", "description": "Required. Name of the resource.", "pattern": "^projects/[^/]+/locations/[^/]+/securityGateways/[^/]+/applications/[^/]+$", "type": "string", "required": true } }, "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/securityGateways/{securityGatewaysId}/applications/{applicationsId}", "description": "Deletes a single application.", "path": "v1/{+name}" }, "get": { "description": "Gets details of a single Application.", "path": "v1/{+name}", "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/securityGateways/{securityGatewaysId}/applications/{applicationsId}", "parameters": { "name": { "required": true, "pattern": "^projects/[^/]+/locations/[^/]+/securityGateways/[^/]+/applications/[^/]+$", "type": "string", "description": "Required. The resource name of the Application using the form: `projects/{project_id}/locations/global/securityGateway/{security_gateway_id}/applications/{application_id}`", "location": "path" } }, "httpMethod": "GET", "parameterOrder": [ "name" ], "response": { "$ref": "GoogleCloudBeyondcorpSecuritygatewaysV1Application" }, "id": "beyondcorp.projects.locations.securityGateways.applications.get", "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ] }, "create": { "parameters": { "applicationId": { "type": "string", "location": "query", "description": "Optional. User-settable Application resource ID. * Must start with a letter. * Must contain between 4-63 characters from `/a-z-/`. * Must end with a number or letter." }, "parent": { "required": true, "type": "string", "pattern": "^projects/[^/]+/locations/[^/]+/securityGateways/[^/]+$", "description": "Required. The resource name of the parent SecurityGateway using the form: `projects/{project_id}/locations/global/securityGateways/{security_gateway_id}`", "location": "path" }, "requestId": { "description": "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.", "location": "query", "type": "string" } }, "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/securityGateways/{securityGatewaysId}/applications", "path": "v1/{+parent}/applications", "request": { "$ref": "GoogleCloudBeyondcorpSecuritygatewaysV1Application" }, "description": "Creates a new Application in a given project and location.", "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "id": "beyondcorp.projects.locations.securityGateways.applications.create", "httpMethod": "POST", "parameterOrder": [ "parent" ], "response": { "$ref": "GoogleLongrunningOperation" } }, "setIamPolicy": { "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/securityGateways/{securityGatewaysId}/applications/{applicationsId}:setIamPolicy", "path": "v1/{+resource}:setIamPolicy", "request": { "$ref": "GoogleIamV1SetIamPolicyRequest" }, "description": "Sets the access control policy on the specified resource. Replaces any existing policy. Can return `NOT_FOUND`, `INVALID_ARGUMENT`, and `PERMISSION_DENIED` errors.", "parameters": { "resource": { "description": "REQUIRED: The resource for which the policy is being specified. See [Resource names](https://cloud.google.com/apis/design/resource_names) for the appropriate value for this field.", "location": "path", "required": true, "pattern": "^projects/[^/]+/locations/[^/]+/securityGateways/[^/]+/applications/[^/]+$", "type": "string" } }, "id": "beyondcorp.projects.locations.securityGateways.applications.setIamPolicy", "httpMethod": "POST", "parameterOrder": [ "resource" ], "response": { "$ref": "GoogleIamV1Policy" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ] }, "list": { "httpMethod": "GET", "parameterOrder": [ "parent" ], "response": { "$ref": "GoogleCloudBeyondcorpSecuritygatewaysV1ListApplicationsResponse" }, "id": "beyondcorp.projects.locations.securityGateways.applications.list", "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "description": "Lists Applications in a given project and location.", "path": "v1/{+parent}/applications", "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/securityGateways/{securityGatewaysId}/applications", "parameters": { "pageToken": { "location": "query", "type": "string", "description": "Optional. The next_page_token value returned from a previous ListApplicationsRequest, if any." }, "orderBy": { "location": "query", "type": "string", "description": "Optional. Specifies the ordering of results. See [Sorting order](https://cloud.google.com/apis/design/design_patterns#sorting_order) for more information." }, "parent": { "description": "Required. The parent location to which the resources belong. `projects/{project_id}/locations/global/securityGateways/{security_gateway_id}`", "location": "path", "required": true, "type": "string", "pattern": "^projects/[^/]+/locations/[^/]+/securityGateways/[^/]+$" }, "filter": { "type": "string", "location": "query", "description": "Optional. A filter specifying constraints of a list operation. All fields in the Application message are supported. For example, the following query will return the Application with displayName \"test-application\" For more information, please refer to https://google.aip.dev/160." }, "pageSize": { "description": "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.", "type": "integer", "location": "query", "format": "int32" } } }, "getIamPolicy": { "httpMethod": "GET", "parameterOrder": [ "resource" ], "response": { "$ref": "GoogleIamV1Policy" }, "id": "beyondcorp.projects.locations.securityGateways.applications.getIamPolicy", "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/securityGateways/{securityGatewaysId}/applications/{applicationsId}:getIamPolicy", "description": "Gets the access control policy for a resource. Returns an empty policy if the resource exists and does not have a policy set.", "path": "v1/{+resource}:getIamPolicy", "parameters": { "resource": { "description": "REQUIRED: The resource for which the policy is being requested. See [Resource names](https://cloud.google.com/apis/design/resource_names) for the appropriate value for this field.", "location": "path", "required": true, "type": "string", "pattern": "^projects/[^/]+/locations/[^/]+/securityGateways/[^/]+/applications/[^/]+$" }, "options.requestedPolicyVersion": { "location": "query", "format": "int32", "type": "integer", "description": "Optional. The maximum policy version that will be used to format the policy. Valid values are 0, 1, and 3. Requests specifying an invalid value will be rejected. Requests for policies with any conditional role bindings must specify version 3. Policies with no conditional role bindings may specify any valid value or leave the field unset. The policy in the response might use the policy version that you specified, or it might use a lower policy version. For example, if you specify version 3, but the policy has no conditional role bindings, the response uses version 1. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies)." } } } } } } }, "appConnectors": { "methods": { "create": { "httpMethod": "POST", "parameterOrder": [ "parent" ], "response": { "$ref": "GoogleLongrunningOperation" }, "id": "beyondcorp.projects.locations.appConnectors.create", "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/appConnectors", "description": "Creates a new AppConnector in a given project and location.", "path": "v1/{+parent}/appConnectors", "request": { "$ref": "GoogleCloudBeyondcorpAppconnectorsV1AppConnector" }, "parameters": { "validateOnly": { "description": "Optional. If set, validates request by executing a dry-run which would not alter the resource in any way.", "type": "boolean", "location": "query" }, "requestId": { "location": "query", "type": "string", "description": "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)." }, "parent": { "required": true, "type": "string", "pattern": "^projects/[^/]+/locations/[^/]+$", "description": "Required. The resource project name of the AppConnector location using the form: `projects/{project_id}/locations/{location_id}`", "location": "path" }, "appConnectorId": { "description": "Optional. User-settable AppConnector resource ID. * Must start with a letter. * Must contain between 4-63 characters from `/a-z-/`. * Must end with a number or a letter.", "type": "string", "location": "query" } } }, "patch": { "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/appConnectors/{appConnectorsId}", "path": "v1/{+name}", "request": { "$ref": "GoogleCloudBeyondcorpAppconnectorsV1AppConnector" }, "description": "Updates the parameters of a single AppConnector.", "parameters": { "validateOnly": { "description": "Optional. If set, validates request by executing a dry-run which would not alter the resource in any way.", "location": "query", "type": "boolean" }, "requestId": { "description": "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).", "type": "string", "location": "query" }, "name": { "type": "string", "pattern": "^projects/[^/]+/locations/[^/]+/appConnectors/[^/]+$", "required": true, "location": "path", "description": "Required. Unique resource name of the AppConnector. The name is ignored when creating a AppConnector." }, "updateMask": { "description": "Required. Mask of fields to update. At least one path must be supplied in this field. The elements of the repeated paths field may only include these fields from [BeyondCorp.AppConnector]: * `labels` * `display_name`", "location": "query", "format": "google-fieldmask", "type": "string" } }, "id": "beyondcorp.projects.locations.appConnectors.patch", "httpMethod": "PATCH", "parameterOrder": [ "name" ], "response": { "$ref": "GoogleLongrunningOperation" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ] }, "setIamPolicy": { "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "id": "beyondcorp.projects.locations.appConnectors.setIamPolicy", "httpMethod": "POST", "parameterOrder": [ "resource" ], "response": { "$ref": "GoogleIamV1Policy" }, "parameters": { "resource": { "description": "REQUIRED: The resource for which the policy is being specified. See [Resource names](https://cloud.google.com/apis/design/resource_names) for the appropriate value for this field.", "location": "path", "required": true, "type": "string", "pattern": "^projects/[^/]+/locations/[^/]+/appConnectors/[^/]+$" } }, "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/appConnectors/{appConnectorsId}:setIamPolicy", "path": "v1/{+resource}:setIamPolicy", "request": { "$ref": "GoogleIamV1SetIamPolicyRequest" }, "description": "Sets the access control policy on the specified resource. Replaces any existing policy. Can return `NOT_FOUND`, `INVALID_ARGUMENT`, and `PERMISSION_DENIED` errors." }, "list": { "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "httpMethod": "GET", "parameterOrder": [ "parent" ], "response": { "$ref": "GoogleCloudBeyondcorpAppconnectorsV1ListAppConnectorsResponse" }, "id": "beyondcorp.projects.locations.appConnectors.list", "parameters": { "pageToken": { "type": "string", "location": "query", "description": "Optional. The next_page_token value returned from a previous ListAppConnectorsRequest, if any." }, "orderBy": { "description": "Optional. Specifies the ordering of results. See [Sorting order](https://cloud.google.com/apis/design/design_patterns#sorting_order) for more information.", "location": "query", "type": "string" }, "parent": { "location": "path", "description": "Required. The resource name of the AppConnector location using the form: `projects/{project_id}/locations/{location_id}`", "pattern": "^projects/[^/]+/locations/[^/]+$", "type": "string", "required": true }, "filter": { "description": "Optional. A filter specifying constraints of a list operation.", "type": "string", "location": "query" }, "pageSize": { "type": "integer", "location": "query", "format": "int32", "description": "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." } }, "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/appConnectors", "description": "Lists AppConnectors in a given project and location.", "path": "v1/{+parent}/appConnectors" }, "getIamPolicy": { "path": "v1/{+resource}:getIamPolicy", "description": "Gets the access control policy for a resource. Returns an empty policy if the resource exists and does not have a policy set.", "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/appConnectors/{appConnectorsId}:getIamPolicy", "parameters": { "resource": { "type": "string", "pattern": "^projects/[^/]+/locations/[^/]+/appConnectors/[^/]+$", "required": true, "location": "path", "description": "REQUIRED: The resource for which the policy is being requested. See [Resource names](https://cloud.google.com/apis/design/resource_names) for the appropriate value for this field." }, "options.requestedPolicyVersion": { "description": "Optional. The maximum policy version that will be used to format the policy. Valid values are 0, 1, and 3. Requests specifying an invalid value will be rejected. Requests for policies with any conditional role bindings must specify version 3. Policies with no conditional role bindings may specify any valid value or leave the field unset. The policy in the response might use the policy version that you specified, or it might use a lower policy version. For example, if you specify version 3, but the policy has no conditional role bindings, the response uses version 1. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies).", "location": "query", "format": "int32", "type": "integer" } }, "id": "beyondcorp.projects.locations.appConnectors.getIamPolicy", "httpMethod": "GET", "parameterOrder": [ "resource" ], "response": { "$ref": "GoogleIamV1Policy" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ] }, "delete": { "parameters": { "name": { "location": "path", "description": "Required. BeyondCorp AppConnector name using the form: `projects/{project_id}/locations/{location_id}/appConnectors/{app_connector_id}`", "type": "string", "pattern": "^projects/[^/]+/locations/[^/]+/appConnectors/[^/]+$", "required": true }, "requestId": { "description": "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).", "location": "query", "type": "string" }, "validateOnly": { "type": "boolean", "location": "query", "description": "Optional. If set, validates request by executing a dry-run which would not alter the resource in any way." } }, "description": "Deletes a single AppConnector.", "path": "v1/{+name}", "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/appConnectors/{appConnectorsId}", "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "httpMethod": "DELETE", "parameterOrder": [ "name" ], "response": { "$ref": "GoogleLongrunningOperation" }, "id": "beyondcorp.projects.locations.appConnectors.delete" }, "get": { "id": "beyondcorp.projects.locations.appConnectors.get", "httpMethod": "GET", "parameterOrder": [ "name" ], "response": { "$ref": "GoogleCloudBeyondcorpAppconnectorsV1AppConnector" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "path": "v1/{+name}", "description": "Gets details of a single AppConnector.", "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/appConnectors/{appConnectorsId}", "parameters": { "name": { "required": true, "type": "string", "pattern": "^projects/[^/]+/locations/[^/]+/appConnectors/[^/]+$", "description": "Required. BeyondCorp AppConnector name using the form: `projects/{project_id}/locations/{location_id}/appConnectors/{app_connector_id}`", "location": "path" } } }, "reportStatus": { "parameters": { "appConnector": { "description": "Required. BeyondCorp Connector name using the form: `projects/{project_id}/locations/{location_id}/connectors/{connector}`", "location": "path", "required": true, "pattern": "^projects/[^/]+/locations/[^/]+/appConnectors/[^/]+$", "type": "string" } }, "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/appConnectors/{appConnectorsId}:reportStatus", "description": "Report status for a given connector.", "path": "v1/{+appConnector}:reportStatus", "request": { "$ref": "GoogleCloudBeyondcorpAppconnectorsV1ReportStatusRequest" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "httpMethod": "POST", "parameterOrder": [ "appConnector" ], "response": { "$ref": "GoogleLongrunningOperation" }, "id": "beyondcorp.projects.locations.appConnectors.reportStatus" }, "resolveInstanceConfig": { "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "id": "beyondcorp.projects.locations.appConnectors.resolveInstanceConfig", "httpMethod": "GET", "parameterOrder": [ "appConnector" ], "response": { "$ref": "GoogleCloudBeyondcorpAppconnectorsV1ResolveInstanceConfigResponse" }, "parameters": { "appConnector": { "pattern": "^projects/[^/]+/locations/[^/]+/appConnectors/[^/]+$", "type": "string", "required": true, "location": "path", "description": "Required. BeyondCorp AppConnector name using the form: `projects/{project_id}/locations/{location_id}/appConnectors/{app_connector}`" } }, "path": "v1/{+appConnector}:resolveInstanceConfig", "description": "Gets instance configuration for a given AppConnector. An internal method called by a AppConnector to get its container config.", "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/appConnectors/{appConnectorsId}:resolveInstanceConfig" }, "testIamPermissions": { "parameters": { "resource": { "description": "REQUIRED: The resource for which the policy detail is being requested. See [Resource names](https://cloud.google.com/apis/design/resource_names) for the appropriate value for this field.", "location": "path", "required": true, "type": "string", "pattern": "^projects/[^/]+/locations/[^/]+/appConnectors/[^/]+$" } }, "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/appConnectors/{appConnectorsId}:testIamPermissions", "description": "Returns permissions that a caller has on the specified resource. If the resource does not exist, this will return an empty set of permissions, not a `NOT_FOUND` error. Note: This operation is designed to be used for building permission-aware UIs and command-line tools, not for authorization checking. This operation may \"fail open\" without warning.", "path": "v1/{+resource}:testIamPermissions", "request": { "$ref": "GoogleIamV1TestIamPermissionsRequest" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "httpMethod": "POST", "parameterOrder": [ "resource" ], "response": { "$ref": "GoogleIamV1TestIamPermissionsResponse" }, "id": "beyondcorp.projects.locations.appConnectors.testIamPermissions" } } }, "appGateways": { "methods": { "list": { "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "id": "beyondcorp.projects.locations.appGateways.list", "httpMethod": "GET", "parameterOrder": [ "parent" ], "response": { "$ref": "ListAppGatewaysResponse" }, "parameters": { "pageToken": { "description": "Optional. The next_page_token value returned from a previous ListAppGatewaysRequest, if any.", "location": "query", "type": "string" }, "orderBy": { "description": "Optional. Specifies the ordering of results. See [Sorting order](https://cloud.google.com/apis/design/design_patterns#sorting_order) for more information.", "type": "string", "location": "query" }, "parent": { "pattern": "^projects/[^/]+/locations/[^/]+$", "type": "string", "required": true, "location": "path", "description": "Required. The resource name of the AppGateway location using the form: `projects/{project_id}/locations/{location_id}`" }, "filter": { "description": "Optional. A filter specifying constraints of a list operation.", "type": "string", "location": "query" }, "pageSize": { "description": "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.", "type": "integer", "location": "query", "format": "int32" } }, "path": "v1/{+parent}/appGateways", "description": "Lists AppGateways in a given project and location.", "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/appGateways" }, "getIamPolicy": { "description": "Gets the access control policy for a resource. Returns an empty policy if the resource exists and does not have a policy set.", "path": "v1/{+resource}:getIamPolicy", "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/appGateways/{appGatewaysId}:getIamPolicy", "parameters": { "resource": { "required": true, "type": "string", "pattern": "^projects/[^/]+/locations/[^/]+/appGateways/[^/]+$", "description": "REQUIRED: The resource for which the policy is being requested. See [Resource names](https://cloud.google.com/apis/design/resource_names) for the appropriate value for this field.", "location": "path" }, "options.requestedPolicyVersion": { "description": "Optional. The maximum policy version that will be used to format the policy. Valid values are 0, 1, and 3. Requests specifying an invalid value will be rejected. Requests for policies with any conditional role bindings must specify version 3. Policies with no conditional role bindings may specify any valid value or leave the field unset. The policy in the response might use the policy version that you specified, or it might use a lower policy version. For example, if you specify version 3, but the policy has no conditional role bindings, the response uses version 1. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies).", "location": "query", "format": "int32", "type": "integer" } }, "httpMethod": "GET", "parameterOrder": [ "resource" ], "response": { "$ref": "GoogleIamV1Policy" }, "id": "beyondcorp.projects.locations.appGateways.getIamPolicy", "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ] }, "setIamPolicy": { "id": "beyondcorp.projects.locations.appGateways.setIamPolicy", "httpMethod": "POST", "parameterOrder": [ "resource" ], "response": { "$ref": "GoogleIamV1Policy" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "path": "v1/{+resource}:setIamPolicy", "request": { "$ref": "GoogleIamV1SetIamPolicyRequest" }, "description": "Sets the access control policy on the specified resource. Replaces any existing policy. Can return `NOT_FOUND`, `INVALID_ARGUMENT`, and `PERMISSION_DENIED` errors.", "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/appGateways/{appGatewaysId}:setIamPolicy", "parameters": { "resource": { "description": "REQUIRED: The resource for which the policy is being specified. See [Resource names](https://cloud.google.com/apis/design/resource_names) for the appropriate value for this field.", "location": "path", "required": true, "type": "string", "pattern": "^projects/[^/]+/locations/[^/]+/appGateways/[^/]+$" } } }, "testIamPermissions": { "id": "beyondcorp.projects.locations.appGateways.testIamPermissions", "httpMethod": "POST", "parameterOrder": [ "resource" ], "response": { "$ref": "GoogleIamV1TestIamPermissionsResponse" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "path": "v1/{+resource}:testIamPermissions", "request": { "$ref": "GoogleIamV1TestIamPermissionsRequest" }, "description": "Returns permissions that a caller has on the specified resource. If the resource does not exist, this will return an empty set of permissions, not a `NOT_FOUND` error. Note: This operation is designed to be used for building permission-aware UIs and command-line tools, not for authorization checking. This operation may \"fail open\" without warning.", "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/appGateways/{appGatewaysId}:testIamPermissions", "parameters": { "resource": { "location": "path", "description": "REQUIRED: The resource for which the policy detail is being requested. See [Resource names](https://cloud.google.com/apis/design/resource_names) for the appropriate value for this field.", "type": "string", "pattern": "^projects/[^/]+/locations/[^/]+/appGateways/[^/]+$", "required": true } } }, "get": { "parameters": { "name": { "description": "Required. BeyondCorp AppGateway name using the form: `projects/{project_id}/locations/{location_id}/appGateways/{app_gateway_id}`", "location": "path", "required": true, "type": "string", "pattern": "^projects/[^/]+/locations/[^/]+/appGateways/[^/]+$" } }, "description": "Gets details of a single AppGateway.", "path": "v1/{+name}", "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/appGateways/{appGatewaysId}", "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "httpMethod": "GET", "parameterOrder": [ "name" ], "response": { "$ref": "AppGateway" }, "id": "beyondcorp.projects.locations.appGateways.get" }, "create": { "parameters": { "validateOnly": { "description": "Optional. If set, validates request by executing a dry-run which would not alter the resource in any way.", "type": "boolean", "location": "query" }, "requestId": { "type": "string", "location": "query", "description": "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)." }, "parent": { "required": true, "type": "string", "pattern": "^projects/[^/]+/locations/[^/]+$", "description": "Required. The resource project name of the AppGateway location using the form: `projects/{project_id}/locations/{location_id}`", "location": "path" }, "appGatewayId": { "description": "Optional. User-settable AppGateway resource ID. * Must start with a letter. * Must contain between 4-63 characters from `/a-z-/`. * Must end with a number or a letter.", "type": "string", "location": "query" } }, "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/appGateways", "path": "v1/{+parent}/appGateways", "request": { "$ref": "AppGateway" }, "description": "Creates a new AppGateway in a given project and location.", "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "id": "beyondcorp.projects.locations.appGateways.create", "httpMethod": "POST", "parameterOrder": [ "parent" ], "response": { "$ref": "GoogleLongrunningOperation" } }, "delete": { "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/appGateways/{appGatewaysId}", "path": "v1/{+name}", "description": "Deletes a single AppGateway.", "parameters": { "name": { "pattern": "^projects/[^/]+/locations/[^/]+/appGateways/[^/]+$", "type": "string", "required": true, "location": "path", "description": "Required. BeyondCorp AppGateway name using the form: `projects/{project_id}/locations/{location_id}/appGateways/{app_gateway_id}`" }, "validateOnly": { "description": "Optional. If set, validates request by executing a dry-run which would not alter the resource in any way.", "location": "query", "type": "boolean" }, "requestId": { "location": "query", "type": "string", "description": "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)." } }, "id": "beyondcorp.projects.locations.appGateways.delete", "httpMethod": "DELETE", "parameterOrder": [ "name" ], "response": { "$ref": "GoogleLongrunningOperation" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ] } } } } } } } }, "parameters": { "prettyPrint": { "description": "Returns response with indentations and line breaks.", "type": "boolean", "default": "true", "location": "query" }, "$.xgafv": { "description": "V1 error format.", "location": "query", "enum": [ "1", "2" ], "enumDescriptions": [ "v1 error format", "v2 error format" ], "type": "string" }, "oauth_token": { "description": "OAuth 2.0 token for the current user.", "location": "query", "type": "string" }, "fields": { "location": "query", "type": "string", "description": "Selector specifying which fields to include in a partial response." }, "upload_protocol": { "type": "string", "location": "query", "description": "Upload protocol for media (e.g. \"raw\", \"multipart\")." }, "uploadType": { "type": "string", "location": "query", "description": "Legacy upload protocol for media (e.g. \"media\", \"multipart\")." }, "access_token": { "description": "OAuth access token.", "type": "string", "location": "query" }, "key": { "description": "API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.", "type": "string", "location": "query" }, "callback": { "description": "JSONP", "type": "string", "location": "query" }, "quotaUser": { "description": "Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.", "type": "string", "location": "query" }, "alt": { "enumDescriptions": [ "Responses with Content-Type of application/json", "Media download with context-dependent Content-Type", "Responses with Content-Type of application/x-protobuf" ], "type": "string", "default": "json", "location": "query", "enum": [ "json", "media", "proto" ], "description": "Data format for response." } }, "icons": { "x16": "http://www.google.com/images/icons/product/search-16.gif", "x32": "http://www.google.com/images/icons/product/search-32.gif" }, "documentationLink": "https://cloud.google.com/" }