googleapis
Version:
Google APIs Client Library for Node.js
1,246 lines (1,245 loc) • 557 kB
TypeScript
import { OAuth2Client, JWT, Compute, UserRefreshClient, BaseExternalAccountClient, GaxiosResponseWithHTTP2, GoogleConfigurable, MethodOptions, StreamMethodOptions, GlobalOptions, GoogleAuth, BodyResponseCallback, APIRequestContext } from 'googleapis-common';
import { Readable } from 'stream';
export declare namespace beyondcorp_v1alpha {
export interface Options extends GlobalOptions {
version: 'v1alpha';
}
interface StandardParameters {
/**
* Auth client or API Key for the request
*/
auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient | BaseExternalAccountClient | GoogleAuth;
/**
* V1 error format.
*/
'$.xgafv'?: string;
/**
* OAuth access token.
*/
access_token?: string;
/**
* Data format for response.
*/
alt?: string;
/**
* JSONP
*/
callback?: string;
/**
* Selector specifying which fields to include in a partial response.
*/
fields?: string;
/**
* 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.
*/
key?: string;
/**
* OAuth 2.0 token for the current user.
*/
oauth_token?: string;
/**
* Returns response with indentations and line breaks.
*/
prettyPrint?: boolean;
/**
* 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.
*/
quotaUser?: string;
/**
* Legacy upload protocol for media (e.g. "media", "multipart").
*/
uploadType?: string;
/**
* Upload protocol for media (e.g. "raw", "multipart").
*/
upload_protocol?: string;
}
/**
* BeyondCorp API
*
* 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.
*
* @example
* ```js
* const {google} = require('googleapis');
* const beyondcorp = google.beyondcorp('v1alpha');
* ```
*/
export class Beyondcorp {
context: APIRequestContext;
organizations: Resource$Organizations;
projects: Resource$Projects;
constructor(options: GlobalOptions, google?: GoogleConfigurable);
}
/**
* Allocated connection of the AppGateway.
*/
export interface Schema$AllocatedConnection {
/**
* Required. The ingress port of an allocated connection
*/
ingressPort?: number | null;
/**
* Required. The PSC uri of an allocated connection
*/
pscUri?: string | null;
}
/**
* 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.
*/
export interface Schema$AppGateway {
/**
* Output only. A list of connections allocated for the Gateway
*/
allocatedConnections?: Schema$AllocatedConnection[];
/**
* Output only. Timestamp when the resource was created.
*/
createTime?: string | null;
/**
* Optional. An arbitrary user-provided name for the AppGateway. Cannot exceed 64 characters.
*/
displayName?: string | null;
/**
* Required. The type of hosting used by the AppGateway.
*/
hostType?: string | null;
/**
* Optional. Resource labels to represent user provided metadata.
*/
labels?: {
[key: string]: string;
} | null;
/**
* Required. Unique resource name of the AppGateway. The name is ignored when creating an AppGateway.
*/
name?: string | null;
/**
* Output only. Reserved for future use.
*/
satisfiesPzi?: boolean | null;
/**
* Output only. Reserved for future use.
*/
satisfiesPzs?: boolean | null;
/**
* Output only. The current state of the AppGateway.
*/
state?: string | null;
/**
* Required. The type of network connectivity used by the AppGateway.
*/
type?: string | null;
/**
* Output only. A unique identifier for the instance generated by the system.
*/
uid?: string | null;
/**
* Output only. Timestamp when the resource was last modified.
*/
updateTime?: string | null;
/**
* Output only. Server-defined URI for this resource.
*/
uri?: string | null;
}
/**
* Represents the metadata of the long-running operation.
*/
export interface Schema$AppGatewayOperationMetadata {
/**
* Output only. API version used to start the operation.
*/
apiVersion?: string | null;
/**
* Output only. The time the operation was created.
*/
createTime?: string | null;
/**
* Output only. The time the operation finished running.
*/
endTime?: string | null;
/**
* 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`.
*/
requestedCancellation?: boolean | null;
/**
* Output only. Human-readable status of the operation, if any.
*/
statusMessage?: string | null;
/**
* Output only. Server-defined resource path for the target of the operation.
*/
target?: string | null;
/**
* Output only. Name of the verb executed by the operation.
*/
verb?: string | null;
}
/**
* ApplicationEndpoint represents a remote application endpoint.
*/
export interface Schema$ApplicationEndpoint {
/**
* Required. Hostname or IP address of the remote application endpoint.
*/
host?: string | null;
/**
* Required. Port of the remote application endpoint.
*/
port?: number | null;
}
/**
* The configuration for Pub/Sub messaging for the connector.
*/
export interface Schema$CloudPubSubNotificationConfig {
/**
* The Pub/Sub subscription the connector uses to receive notifications.
*/
pubsubSubscription?: string | null;
}
/**
* ConnectionConfig represents a Connection Configuration object.
*/
export interface Schema$CloudSecurityZerotrustApplinkAppConnectorProtoConnectionConfig {
/**
* application_endpoint is the endpoint of the application the form of host:port. For example, "localhost:80".
*/
applicationEndpoint?: string | null;
/**
* application_name represents the given name of the application the connection is connecting with.
*/
applicationName?: string | null;
/**
* gateway lists all instances running a gateway in GCP. They all connect to a connector on the host.
*/
gateway?: Schema$CloudSecurityZerotrustApplinkAppConnectorProtoGateway[];
/**
* 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\}
*/
name?: string | null;
/**
* project represents the consumer project the connection belongs to.
*/
project?: string | null;
/**
* tunnels_per_gateway reflects the number of tunnels between a connector and a gateway.
*/
tunnelsPerGateway?: number | null;
/**
* user_port specifies the reserved port on gateways for user connections.
*/
userPort?: number | null;
}
/**
* ConnectorDetails reflects the details of a connector.
*/
export interface Schema$CloudSecurityZerotrustApplinkAppConnectorProtoConnectorDetails {
}
/**
* Gateway represents a GCE VM Instance endpoint for use by IAP TCP.
*/
export interface Schema$CloudSecurityZerotrustApplinkAppConnectorProtoGateway {
/**
* interface specifies the network interface of the gateway to connect to.
*/
interface?: string | null;
/**
* 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\}
*/
name?: string | null;
/**
* port specifies the port of the gateway for tunnel connections from the connectors.
*/
port?: number | null;
/**
* 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\}
*/
project?: string | null;
/**
* self_link is the gateway URL in the form https://www.googleapis.com/compute/${version\}/projects/${project\}/zones/${zone\}/instances/${instance\}
*/
selfLink?: string | null;
/**
* 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\}
*/
zone?: string | null;
}
/**
* LogAgentDetails reflects the details of a log agent.
*/
export interface Schema$CloudSecurityZerotrustApplinkLogagentProtoLogAgentDetails {
}
/**
* A BeyondCorp Connection resource represents a BeyondCorp protected connection to a remote application. It creates all the necessary GCP components needed for creating a BeyondCorp protected connection. Multiple connectors can be authorised for a single Connection.
*/
export interface Schema$Connection {
/**
* Required. Address of the remote application endpoint for the BeyondCorp Connection.
*/
applicationEndpoint?: Schema$ApplicationEndpoint;
/**
* Optional. List of [google.cloud.beyondcorp.v1main.Connector.name] that are authorised to be associated with this Connection.
*/
connectors?: string[] | null;
/**
* Output only. Timestamp when the resource was created.
*/
createTime?: string | null;
/**
* Optional. An arbitrary user-provided name for the connection. Cannot exceed 64 characters.
*/
displayName?: string | null;
/**
* Optional. Gateway used by the connection.
*/
gateway?: Schema$Gateway;
/**
* Optional. Resource labels to represent user provided metadata.
*/
labels?: {
[key: string]: string;
} | null;
/**
* Required. Unique resource name of the connection. The name is ignored when creating a connection.
*/
name?: string | null;
/**
* Output only. The current state of the connection.
*/
state?: string | null;
/**
* Required. The type of network connectivity used by the connection.
*/
type?: string | null;
/**
* Output only. A unique identifier for the instance generated by the system.
*/
uid?: string | null;
/**
* Output only. Timestamp when the resource was last modified.
*/
updateTime?: string | null;
}
/**
* Details of the Connection.
*/
export interface Schema$ConnectionDetails {
/**
* A BeyondCorp Connection in the project.
*/
connection?: Schema$Connection;
/**
* 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\}".
*/
recentMigVms?: string[] | null;
}
/**
* Represents the metadata of the long-running operation.
*/
export interface Schema$ConnectionOperationMetadata {
/**
* Output only. API version used to start the operation.
*/
apiVersion?: string | null;
/**
* Output only. The time the operation was created.
*/
createTime?: string | null;
/**
* Output only. The time the operation finished running.
*/
endTime?: string | null;
/**
* 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`.
*/
requestedCancellation?: boolean | null;
/**
* Output only. Human-readable status of the operation, if any.
*/
statusMessage?: string | null;
/**
* Output only. Server-defined resource path for the target of the operation.
*/
target?: string | null;
/**
* Output only. Name of the verb executed by the operation.
*/
verb?: string | null;
}
/**
* 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.
*/
export interface Schema$Connector {
/**
* Output only. Timestamp when the resource was created.
*/
createTime?: string | null;
/**
* Optional. An arbitrary user-provided name for the connector. Cannot exceed 64 characters.
*/
displayName?: string | null;
/**
* Optional. Resource labels to represent user provided metadata.
*/
labels?: {
[key: string]: string;
} | null;
/**
* Required. Unique resource name of the connector. The name is ignored when creating a connector.
*/
name?: string | null;
/**
* Required. Principal information about the Identity of the connector.
*/
principalInfo?: Schema$PrincipalInfo;
/**
* Optional. Resource info of the connector.
*/
resourceInfo?: Schema$ResourceInfo;
/**
* Output only. The current state of the connector.
*/
state?: string | null;
/**
* Output only. A unique identifier for the instance generated by the system.
*/
uid?: string | null;
/**
* Output only. Timestamp when the resource was last modified.
*/
updateTime?: string | null;
}
/**
* ConnectorInstanceConfig defines the instance config of a connector.
*/
export interface Schema$ConnectorInstanceConfig {
/**
* ImageConfig defines the GCR images to run for the remote agent's control plane.
*/
imageConfig?: Schema$ImageConfig;
/**
* The SLM instance agent configuration.
*/
instanceConfig?: {
[key: string]: any;
} | null;
/**
* NotificationConfig defines the notification mechanism that the remote instance should subscribe to in order to receive notification.
*/
notificationConfig?: Schema$NotificationConfig;
/**
* 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.
*/
sequenceNumber?: string | null;
}
/**
* Represents the metadata of the long-running operation.
*/
export interface Schema$ConnectorOperationMetadata {
/**
* Output only. API version used to start the operation.
*/
apiVersion?: string | null;
/**
* Output only. The time the operation was created.
*/
createTime?: string | null;
/**
* Output only. The time the operation finished running.
*/
endTime?: string | null;
/**
* 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`.
*/
requestedCancellation?: boolean | null;
/**
* Output only. Human-readable status of the operation, if any.
*/
statusMessage?: string | null;
/**
* Output only. Server-defined resource path for the target of the operation.
*/
target?: string | null;
/**
* Output only. Name of the verb executed by the operation.
*/
verb?: string | null;
}
/**
* ContainerHealthDetails reflects the health details of a container.
*/
export interface Schema$ContainerHealthDetails {
/**
* The version of the current config.
*/
currentConfigVersion?: string | null;
/**
* The latest error message.
*/
errorMsg?: string | null;
/**
* The version of the expected config.
*/
expectedConfigVersion?: string | null;
/**
* The extended status. Such as ExitCode, StartedAt, FinishedAt, etc.
*/
extendedStatus?: {
[key: string]: string;
} | null;
}
/**
* 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); \}
*/
export interface Schema$Empty {
}
/**
* Gateway represents a user facing component that serves as an entrance to enable connectivity.
*/
export interface Schema$Gateway {
/**
* Required. The type of hosting used by the gateway.
*/
type?: string | null;
/**
* Output only. Server-defined URI for this resource.
*/
uri?: string | null;
/**
* Output only. User port reserved on the gateways for this connection, if not specified or zero, the default port is 19443.
*/
userPort?: number | null;
}
/**
* 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 authorised for a single AppConnection.
*/
export interface Schema$GoogleCloudBeyondcorpAppconnectionsV1alphaAppConnection {
/**
* Required. Address of the remote application endpoint for the BeyondCorp AppConnection.
*/
applicationEndpoint?: Schema$GoogleCloudBeyondcorpAppconnectionsV1alphaAppConnectionApplicationEndpoint;
/**
* Optional. List of [google.cloud.beyondcorp.v1main.Connector.name] that are authorised to be associated with this AppConnection.
*/
connectors?: string[] | null;
/**
* Output only. Timestamp when the resource was created.
*/
createTime?: string | null;
/**
* Optional. An arbitrary user-provided name for the AppConnection. Cannot exceed 64 characters.
*/
displayName?: string | null;
/**
* Optional. Gateway used by the AppConnection.
*/
gateway?: Schema$GoogleCloudBeyondcorpAppconnectionsV1alphaAppConnectionGateway;
/**
* Optional. Resource labels to represent user provided metadata.
*/
labels?: {
[key: string]: string;
} | null;
/**
* Required. Unique resource name of the AppConnection. The name is ignored when creating a AppConnection.
*/
name?: string | null;
/**
* Output only. Reserved for future use.
*/
satisfiesPzi?: boolean | null;
/**
* Output only. Reserved for future use.
*/
satisfiesPzs?: boolean | null;
/**
* Output only. The current state of the AppConnection.
*/
state?: string | null;
/**
* Required. The type of network connectivity used by the AppConnection.
*/
type?: string | null;
/**
* Output only. A unique identifier for the instance generated by the system.
*/
uid?: string | null;
/**
* Output only. Timestamp when the resource was last modified.
*/
updateTime?: string | null;
}
/**
* ApplicationEndpoint represents a remote application endpoint.
*/
export interface Schema$GoogleCloudBeyondcorpAppconnectionsV1alphaAppConnectionApplicationEndpoint {
/**
* Required. Hostname or IP address of the remote application endpoint.
*/
host?: string | null;
/**
* Required. Port of the remote application endpoint.
*/
port?: number | null;
}
/**
* Gateway represents a user facing component that serves as an entrance to enable connectivity.
*/
export interface Schema$GoogleCloudBeyondcorpAppconnectionsV1alphaAppConnectionGateway {
/**
* Required. AppGateway name in following format: `projects/{project_id\}/locations/{location_id\}/appgateways/{gateway_id\}`
*/
appGateway?: string | null;
/**
* Output only. Ingress port reserved on the gateways for this AppConnection, if not specified or zero, the default port is 19443.
*/
ingressPort?: number | null;
/**
* Output only. L7 private service connection for this resource.
*/
l7psc?: string | null;
/**
* Required. The type of hosting used by the gateway.
*/
type?: string | null;
/**
* Output only. Server-defined URI for this resource.
*/
uri?: string | null;
}
/**
* Represents the metadata of the long-running operation.
*/
export interface Schema$GoogleCloudBeyondcorpAppconnectionsV1alphaAppConnectionOperationMetadata {
/**
* Output only. API version used to start the operation.
*/
apiVersion?: string | null;
/**
* Output only. The time the operation was created.
*/
createTime?: string | null;
/**
* Output only. The time the operation finished running.
*/
endTime?: string | null;
/**
* 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`.
*/
requestedCancellation?: boolean | null;
/**
* Output only. Human-readable status of the operation, if any.
*/
statusMessage?: string | null;
/**
* Output only. Server-defined resource path for the target of the operation.
*/
target?: string | null;
/**
* Output only. Name of the verb executed by the operation.
*/
verb?: string | null;
}
/**
* Response message for BeyondCorp.ListAppConnections.
*/
export interface Schema$GoogleCloudBeyondcorpAppconnectionsV1alphaListAppConnectionsResponse {
/**
* A list of BeyondCorp AppConnections in the project.
*/
appConnections?: Schema$GoogleCloudBeyondcorpAppconnectionsV1alphaAppConnection[];
/**
* A token to retrieve the next page of results, or empty if there are no more results in the list.
*/
nextPageToken?: string | null;
/**
* A list of locations that could not be reached.
*/
unreachable?: string[] | null;
}
/**
* Response message for BeyondCorp.ResolveAppConnections.
*/
export interface Schema$GoogleCloudBeyondcorpAppconnectionsV1alphaResolveAppConnectionsResponse {
/**
* A list of BeyondCorp AppConnections with details in the project.
*/
appConnectionDetails?: Schema$GoogleCloudBeyondcorpAppconnectionsV1alphaResolveAppConnectionsResponseAppConnectionDetails[];
/**
* A token to retrieve the next page of results, or empty if there are no more results in the list.
*/
nextPageToken?: string | null;
/**
* A list of locations that could not be reached.
*/
unreachable?: string[] | null;
}
/**
* Details of the AppConnection.
*/
export interface Schema$GoogleCloudBeyondcorpAppconnectionsV1alphaResolveAppConnectionsResponseAppConnectionDetails {
/**
* A BeyondCorp AppConnection in the project.
*/
appConnection?: Schema$GoogleCloudBeyondcorpAppconnectionsV1alphaAppConnection;
/**
* 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\}`.
*/
recentMigVms?: string[] | null;
}
/**
* Represents the metadata of the long-running operation.
*/
export interface Schema$GoogleCloudBeyondcorpAppconnectionsV1AppConnectionOperationMetadata {
/**
* Output only. API version used to start the operation.
*/
apiVersion?: string | null;
/**
* Output only. The time the operation was created.
*/
createTime?: string | null;
/**
* Output only. The time the operation finished running.
*/
endTime?: string | null;
/**
* 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`.
*/
requestedCancellation?: boolean | null;
/**
* Output only. Human-readable status of the operation, if any.
*/
statusMessage?: string | null;
/**
* Output only. Server-defined resource path for the target of the operation.
*/
target?: string | null;
/**
* Output only. Name of the verb executed by the operation.
*/
verb?: string | null;
}
/**
* 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.
*/
export interface Schema$GoogleCloudBeyondcorpAppconnectorsV1alphaAppConnector {
/**
* Output only. Timestamp when the resource was created.
*/
createTime?: string | null;
/**
* Optional. An arbitrary user-provided name for the AppConnector. Cannot exceed 64 characters.
*/
displayName?: string | null;
/**
* Optional. Resource labels to represent user provided metadata.
*/
labels?: {
[key: string]: string;
} | null;
/**
* Required. Unique resource name of the AppConnector. The name is ignored when creating a AppConnector.
*/
name?: string | null;
/**
* Required. Principal information about the Identity of the AppConnector.
*/
principalInfo?: Schema$GoogleCloudBeyondcorpAppconnectorsV1alphaAppConnectorPrincipalInfo;
/**
* Optional. Resource info of the connector.
*/
resourceInfo?: Schema$GoogleCloudBeyondcorpAppconnectorsV1alphaResourceInfo;
/**
* Output only. The current state of the AppConnector.
*/
state?: string | null;
/**
* Output only. A unique identifier for the instance generated by the system.
*/
uid?: string | null;
/**
* Output only. Timestamp when the resource was last modified.
*/
updateTime?: string | null;
}
/**
* AppConnectorInstanceConfig defines the instance config of a AppConnector.
*/
export interface Schema$GoogleCloudBeyondcorpAppconnectorsV1alphaAppConnectorInstanceConfig {
/**
* ImageConfig defines the GCR images to run for the remote agent's control plane.
*/
imageConfig?: Schema$GoogleCloudBeyondcorpAppconnectorsV1alphaImageConfig;
/**
* The SLM instance agent configuration.
*/
instanceConfig?: {
[key: string]: any;
} | null;
/**
* NotificationConfig defines the notification mechanism that the remote instance should subscribe to in order to receive notification.
*/
notificationConfig?: Schema$GoogleCloudBeyondcorpAppconnectorsV1alphaNotificationConfig;
/**
* 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.
*/
sequenceNumber?: string | null;
}
/**
* Represents the metadata of the long-running operation.
*/
export interface Schema$GoogleCloudBeyondcorpAppconnectorsV1alphaAppConnectorOperationMetadata {
/**
* Output only. API version used to start the operation.
*/
apiVersion?: string | null;
/**
* Output only. The time the operation was created.
*/
createTime?: string | null;
/**
* Output only. The time the operation finished running.
*/
endTime?: string | null;
/**
* 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`.
*/
requestedCancellation?: boolean | null;
/**
* Output only. Human-readable status of the operation, if any.
*/
statusMessage?: string | null;
/**
* Output only. Server-defined resource path for the target of the operation.
*/
target?: string | null;
/**
* Output only. Name of the verb executed by the operation.
*/
verb?: string | null;
}
/**
* PrincipalInfo represents an Identity oneof.
*/
export interface Schema$GoogleCloudBeyondcorpAppconnectorsV1alphaAppConnectorPrincipalInfo {
/**
* A GCP service account.
*/
serviceAccount?: Schema$GoogleCloudBeyondcorpAppconnectorsV1alphaAppConnectorPrincipalInfoServiceAccount;
}
/**
* ServiceAccount represents a GCP service account.
*/
export interface Schema$GoogleCloudBeyondcorpAppconnectorsV1alphaAppConnectorPrincipalInfoServiceAccount {
/**
* Email address of the service account.
*/
email?: string | null;
}
/**
* ContainerHealthDetails reflects the health details of a container.
*/
export interface Schema$GoogleCloudBeyondcorpAppconnectorsV1alphaContainerHealthDetails {
/**
* The version of the current config.
*/
currentConfigVersion?: string | null;
/**
* The latest error message.
*/
errorMsg?: string | null;
/**
* The version of the expected config.
*/
expectedConfigVersion?: string | null;
/**
* The extended status. Such as ExitCode, StartedAt, FinishedAt, etc.
*/
extendedStatus?: {
[key: string]: string;
} | null;
}
/**
* ImageConfig defines the control plane images to run.
*/
export interface Schema$GoogleCloudBeyondcorpAppconnectorsV1alphaImageConfig {
/**
* 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
*/
stableImage?: string | null;
/**
* 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
*/
targetImage?: string | null;
}
/**
* Response message for BeyondCorp.ListAppConnectors.
*/
export interface Schema$GoogleCloudBeyondcorpAppconnectorsV1alphaListAppConnectorsResponse {
/**
* A list of BeyondCorp AppConnectors in the project.
*/
appConnectors?: Schema$GoogleCloudBeyondcorpAppconnectorsV1alphaAppConnector[];
/**
* A token to retrieve the next page of results, or empty if there are no more results in the list.
*/
nextPageToken?: string | null;
/**
* A list of locations that could not be reached.
*/
unreachable?: string[] | null;
}
/**
* NotificationConfig defines the mechanisms to notify instance agent.
*/
export interface Schema$GoogleCloudBeyondcorpAppconnectorsV1alphaNotificationConfig {
/**
* Cloud Pub/Sub Configuration to receive notifications.
*/
pubsubNotification?: Schema$GoogleCloudBeyondcorpAppconnectorsV1alphaNotificationConfigCloudPubSubNotificationConfig;
}
/**
* The configuration for Pub/Sub messaging for the AppConnector.
*/
export interface Schema$GoogleCloudBeyondcorpAppconnectorsV1alphaNotificationConfigCloudPubSubNotificationConfig {
/**
* The Pub/Sub subscription the AppConnector uses to receive notifications.
*/
pubsubSubscription?: string | null;
}
/**
* RemoteAgentDetails reflects the details of a remote agent.
*/
export interface Schema$GoogleCloudBeyondcorpAppconnectorsV1alphaRemoteAgentDetails {
}
/**
* Request report the connector status.
*/
export interface Schema$GoogleCloudBeyondcorpAppconnectorsV1alphaReportStatusRequest {
/**
* 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).
*/
requestId?: string | null;
/**
* Required. Resource info of the connector.
*/
resourceInfo?: Schema$GoogleCloudBeyondcorpAppconnectorsV1alphaResourceInfo;
/**
* Optional. If set, validates request by executing a dry-run which would not alter the resource in any way.
*/
validateOnly?: boolean | null;
}
/**
* Response message for BeyondCorp.ResolveInstanceConfig.
*/
export interface Schema$GoogleCloudBeyondcorpAppconnectorsV1alphaResolveInstanceConfigResponse {
/**
* AppConnectorInstanceConfig.
*/
instanceConfig?: Schema$GoogleCloudBeyondcorpAppconnectorsV1alphaAppConnectorInstanceConfig;
}
/**
* ResourceInfo represents the information/status of an app connector resource. Such as: - remote_agent - container - runtime - appgateway - appconnector - appconnection - tunnel - logagent
*/
export interface Schema$GoogleCloudBeyondcorpAppconnectorsV1alphaResourceInfo {
/**
* Required. Unique Id for the resource.
*/
id?: string | null;
/**
* Specific details for the resource. This is for internal use only.
*/
resource?: {
[key: string]: any;
} | null;
/**
* Overall health status. Overall status is derived based on the status of each sub level resources.
*/
status?: string | null;
/**
* List of Info for the sub level resources.
*/
sub?: Schema$GoogleCloudBeyondcorpAppconnectorsV1alphaResourceInfo[];
/**
* The timestamp to collect the info. It is suggested to be set by the topmost level resource only.
*/
time?: string | null;
}
/**
* Represents the metadata of the long-running operation.
*/
export interface Schema$GoogleCloudBeyondcorpAppconnectorsV1AppConnectorOperationMetadata {
/**
* Output only. API version used to start the operation.
*/
apiVersion?: string | null;
/**
* Output only. The time the operation was created.
*/
createTime?: string | null;
/**
* Output only. The time the operation finished running.
*/
endTime?: string | null;
/**
* 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`.
*/
requestedCancellation?: boolean | null;
/**
* Output only. Human-readable status of the operation, if any.
*/
statusMessage?: string | null;
/**
* Output only. Server-defined resource path for the target of the operation.
*/
target?: string | null;
/**
* Output only. Name of the verb executed by the operation.
*/
verb?: string | null;
}
/**
* ContainerHealthDetails reflects the health details of a container.
*/
export interface Schema$GoogleCloudBeyondcorpAppconnectorsV1ContainerHealthDetails {
/**
* The version of the current config.
*/
currentConfigVersion?: string | null;
/**
* The latest error message.
*/
errorMsg?: string | null;
/**
* The version of the expected config.
*/
expectedConfigVersion?: string | null;
/**
* The extended status. Such as ExitCode, StartedAt, FinishedAt, etc.
*/
extendedStatus?: {
[key: string]: string;
} | null;
}
/**
* RemoteAgentDetails reflects the details of a remote agent.
*/
export interface Schema$GoogleCloudBeyondcorpAppconnectorsV1RemoteAgentDetails {
}
/**
* Represents the metadata of the long-running operation.
*/
export interface Schema$GoogleCloudBeyondcorpAppgatewaysV1AppGatewayOperationMetadata {
/**
* Output only. API version used to start the operation.
*/
apiVersion?: string | null;
/**
* Output only. The time the operation was created.
*/
createTime?: string | null;
/**
* Output only. The time the operation finished running.
*/
endTime?: string | null;
/**
* 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`.
*/
requestedCancellation?: boolean | null;
/**
* Output only. Human-readable status of the operation, if any.
*/
statusMessage?: string | null;
/**
* Output only. Server-defined resource path for the target of the operation.
*/
target?: string | null;
/**
* Output only. Name of the verb executed by the operation.
*/
verb?: string | null;
}
/**
* Represents the metadata of the long-running operation.
*/
export interface Schema$GoogleCloudBeyondcorpPartnerservicesV1alphaPartnerServiceOperationMetadata {
/**
* Output only. API version used to start the operation.
*/
apiVersion?: string | null;
/**
* Output only. The time the operation was created.
*/
createTime?: string | null;
/**
* Output only. The time the operation finished running.
*/
endTime?: string | null;
/**
* 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`.
*/
requestedCancellation?: boolean | null;
/**
* Output only. Human-readable status of the operation, if any.
*/
statusMessage?: string | null;
/**
* Output only. Server-defined resource path for the target of the operation.
*/
target?: string | null;
/**
* Output only. Name of the verb executed by the operation.
*/
verb?: string | null;
}
/**
* Represents the metadata of the long-running operation.
*/
export interface Schema$GoogleCloudBeyondcorpPartnerservicesV1mainPartnerServiceOperationMetadata {
/**
* Output only. API version used to start the operation.
*/
apiVersion?: string | null;
/**
* Output only. The time the operation was created.
*/
createTime?: string | null;
/**
* Output only. The time the operation finished running.
*/
endTime?: string | null;
/**
* 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`.
*/
requestedCancellation?: boolean | null;
/**
* Output only. Human-readable status of the operation, if any.
*/
statusMessage?: string | null;
/**
* Output only. Server-defined resource path for the target of the operation.
*/
target?: string | null;
/**
* Output only. Name of the verb executed by the operation.
*/
verb?: string | null;
}
/**
* The configuration that was applied to generate the result.
*/
export interface Schema$GoogleCloudBeyondcorpSaasplatformInsightsV1alphaAppliedConfig {
/**
* Output only. Aggregation type applied.
*/
aggregation?: string | null;
/**
* Output only. Customised grouping applied.
*/
customGrouping?: Schema$GoogleCloudBeyondcorpSaasplatformInsightsV1alphaCustomGrouping;
/**
* Output only. Ending time for the duration for which insight was pulled.
*/
endTime?: string | null;
/**
* Output only. Filters applied.
*/
fieldFilter?: string | null;
/**
* Output only. Group id of the grouping applied.
*/
group?: string | null;
/**
* Output only. Starting time for the duration for which insight was pulled.
*/
startTime?: string | null;
}
/**
* The response for the configured insight.
*/
export interface Schema$GoogleCloudBeyondcorpSaasplatformInsightsV1alphaConfiguredInsightResponse {
/**
* Output only. Applied insight config to generate the result data rows.
*/
appliedConfig?: Schema$GoogleCloudBeyondcorpSaasplatformInsightsV1alphaAppliedConfig;
/**
* Output only. Next page token to be fetched. Set to empty or NULL if there are no more pages available.
*/
nextPageToken?: string | null;
/**
* Output only. Result rows returned containing the required value(s) for configured insight.
*/
rows?: Schema$GoogleCloudBeyondcorpSaasplatformInsightsV1alphaRow[];
}
/**
* Customised grouping option that allows setting the group_by fields and also the filters togather for a configured insight request.
*/
export interface Schema$GoogleCloudBeyondcorpSaasplatformInsightsV1alphaCustomGrouping {
/**
* Optional. Filterable parameters to be added to the grouping clause. Available fields could be fetched by calling insight list and get APIs in `BASIC` view. `=` is the only comparison operator supported. `AND` is the only logical operator supported. Usage: field_filter="fieldName1=fieldVal1 AND fieldName2=fieldVal2". NOTE: Only `AND` conditions are allowed. NOTE: Use the `filter_alias` from `Insight.Metadata.Field` message for the filtering the corresponding fields in this filter field. (These expressions are based on the filter language described at https://google.aip.dev/160).
*/
fieldFilter?: string | null;
/**
* Required. Fields to be used for grouping. NOTE: Use the `filter_alias` from `Insight.Metadata.Field` message for declaring the fields to be grouped-by here.
*/
groupFields?: string[] | null;
}
/**
* The Insight object with configuration that was returned and actual list of records.
*/
export interface Schema$GoogleCloudBeyondcorpSaasplatformInsightsV1alphaInsight {
/**
* Output only. Applied insight config to generate the result data rows.
*/
appliedConfig?: Schema$GoogleCloudBeyondcorpSaasplatformInsightsV1alphaAppliedConfig;
/**
* Output only. Metadata for the Insight.
*/
metadata?: Schema$GoogleCloudBeyondcorpSaasplatformInsightsV1alphaInsightMetadata;
/**
* Output only. The insight resource name. e.g. `organizations/{organization_id\}/locations/{location_id\}/insights/{insight_id\}` OR `projects/{project_id\}/locations/{location_id\}/insights/{insight_id\}`.
*/
name?: string | null;
/**
* Output only. Result rows returned containing the required value(s).
*/
rows?: Schema$GoogleCloudBeyondcorpSaasplatformInsightsV1alphaRow[];
}
/**
* Insight filters, groupings and aggregations that can be applied for the insight. Examples: aggregations, groups, field filters.
*/
export interface Schema$GoogleCloudBeyondcorpSaasplatformInsightsV1alphaInsightMetadata {
/**
* Output only. List of aggregation types available for insight.
*/
aggregations?: string[] | null;
/**
* Output only. Category of the insight.
*/
category?: string | null;
/**
* Output only. Common name of the insight.
*/
displayName?: string | null;
/**
* Output only. List of fields available for insight.
*/
fields?: Schema$GoogleCloudBeyondcorpSaasplatformInsightsV1alphaInsightMetadataField[];
/**
* Output only. List of groupings available for insight.
*/
groups?: string[] | null;
/**
* Output only. Sub-Category of the insight.
*/
subCategory?: string | null;
/**
* Output only. Type of the insight. It is metadata describing whether the insight is a metric (e.g. count) or a report (e.g. list, status).
*/
type?: string | null;
}
/**
* Field metadata. Commonly understandable name and description for the field. Multiple such fields constitute the Insight.
*/