REST Resource: projects.locations.appConnectors

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 (State),
  "principalInfo": {
    object (PrincipalInfo)
  },
  "resourceInfo": {
    object (ResourceInfo)
  }
}
Fields
name

string

Required. Unique resource name of the AppConnector. The name is ignored when creating a AppConnector.

createTime

string (Timestamp format)

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: "2014-10-02T15:01:23Z" and "2014-10-02T15:01:23.045123456Z".

updateTime

string (Timestamp format)

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: "2014-10-02T15:01:23Z" and "2014-10-02T15:01:23.045123456Z".

labels

map (key: string, value: string)

Optional. Resource labels to represent user provided metadata.

An object containing a list of "key": value pairs. Example: { "name": "wrench", "mass": "1.3kg", "count": "3" }.

displayName

string

Optional. An arbitrary user-provided name for the AppConnector. Cannot exceed 64 characters.

uid

string

Output only. A unique identifier for the instance generated by the system.

state

enum (State)

Output only. The current state of the AppConnector.

principalInfo

object (PrincipalInfo)

Required. Principal information about the Identity of the AppConnector.

resourceInfo

object (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
{
  "serviceAccount": {
    object (ServiceAccount)
  }
}
Fields
serviceAccount

object (ServiceAccount)

A GCP service account.

ServiceAccount

ServiceAccount represents a GCP service account.

JSON representation
{
  "email": string
}
Fields
email

string

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 (HealthStatus),
  "resource": {
    "@type": string,
    field1: ...,
    ...
  },
  "time": string,
  "sub": [
    {
      object (ResourceInfo)
    }
  ]
}
Fields
id

string

Required. Unique Id for the resource.

status

enum (HealthStatus)

Overall health status. Overall status is derived based on the status of each sub level resources.

resource

object

Specific details for the resource. This is for internal use only.

An object containing fields of an arbitrary type. An additional field "@type" contains a URI identifying the type. Example: { "id": 1234, "@type": "types.example.com/standard/id" }.

time

string (Timestamp format)

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: "2014-10-02T15:01:23Z" and "2014-10-02T15:01:23.045123456Z".

sub[]

object (ResourceInfo)

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

create

Creates a new AppConnector in a given project and location.

delete

Deletes a single AppConnector.

get

Gets details of a single AppConnector.

getIamPolicy

Gets the access control policy for a resource.

list

Lists AppConnectors in a given project and location.

patch

Updates the parameters of a single AppConnector.

reportStatus

Report status for a given connector.

resolveInstanceConfig

Get instance config for a given AppConnector.

setIamPolicy

Sets the access control policy on the specified resource.

testIamPermissions

Returns permissions that a caller has on the specified resource.