Resource: AppConnector
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.
JSON representation |
---|
{ "name": string, "createTime": string, "updateTime": string, "labels": { string: string, ... }, "displayName": string, "uid": string, "state": enum ( |
Fields | |
---|---|
name |
Required. Unique resource name of the AppConnector. The name is ignored when creating a AppConnector. |
createTime |
Output only. Timestamp when the resource was created. A timestamp in RFC3339 UTC "Zulu" format, with nanosecond resolution and up to nine fractional digits. Examples: |
updateTime |
Output only. Timestamp when the resource was last modified. A timestamp in RFC3339 UTC "Zulu" format, with nanosecond resolution and up to nine fractional digits. Examples: |
labels |
Optional. Resource labels to represent user provided metadata. An object containing a list of |
displayName |
Optional. An arbitrary user-provided name for the AppConnector. Cannot exceed 64 characters. |
uid |
Output only. A unique identifier for the instance generated by the system. |
state |
Output only. The current state of the AppConnector. |
principalInfo |
Required. Principal information about the Identity of the AppConnector. |
resourceInfo |
Optional. Resource info of the connector. |
State
Represents the different states of a AppConnector.
Enums | |
---|---|
STATE_UNSPECIFIED |
Default value. This value is unused. |
CREATING |
AppConnector is being created. |
CREATED |
AppConnector has been created. |
UPDATING |
AppConnector's configuration is being updated. |
DELETING |
AppConnector is being deleted. |
DOWN |
AppConnector is down and may be restored in the future. This happens when CCFE sends ProjectState = OFF. |
PrincipalInfo
PrincipalInfo represents an Identity oneof.
JSON representation |
---|
{ // Union field |
Fields | |
---|---|
Union field
|
|
serviceAccount |
A GCP service account. |
ServiceAccount
ServiceAccount represents a GCP service account.
JSON representation |
---|
{ "email": string } |
Fields | |
---|---|
email |
Email address of the service account. |
ResourceInfo
ResourceInfo represents the information/status of an app connector resource. Such as: - remote_agent - container - runtime - appgateway - appconnector - appconnection - tunnel - logagent
JSON representation |
---|
{ "id": string, "status": enum ( |
Fields | |
---|---|
id |
Required. Unique Id for the resource. |
status |
Overall health status. Overall status is derived based on the status of each sub level resources. |
resource |
Specific details for the resource. This is for internal use only. An object containing fields of an arbitrary type. An additional field |
time |
The timestamp to collect the info. It is suggested to be set by the topmost level resource only. A timestamp in RFC3339 UTC "Zulu" format, with nanosecond resolution and up to nine fractional digits. Examples: |
sub[] |
List of Info for the sub level resources. |
HealthStatus
HealthStatus represents the health status.
Enums | |
---|---|
HEALTH_STATUS_UNSPECIFIED |
Health status is unknown: not initialized or failed to retrieve. |
HEALTHY |
The resource is healthy. |
UNHEALTHY |
The resource is unhealthy. |
UNRESPONSIVE |
The resource is unresponsive. |
DEGRADED |
Some sub-resources are UNHEALTHY. |
Methods |
|
---|---|
|
Creates a new AppConnector in a given project and location. |
|
Deletes a single AppConnector. |
|
Gets details of a single AppConnector. |
|
Gets the access control policy for a resource. |
|
Lists AppConnectors in a given project and location. |
|
Updates the parameters of a single AppConnector. |
|
Report status for a given connector. |
|
Gets instance configuration for a given AppConnector. |
|
Sets the access control policy on the specified resource. |
|
Returns permissions that a caller has on the specified resource. |