Reference documentation and code samples for the Google Cloud BeyondCorp AppConnections V1 Client class AppConnection.
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.
Generated from protobuf message google.cloud.beyondcorp.appconnections.v1.AppConnection
Methods
__construct
Constructor.
| Parameters | |
|---|---|
| Name | Description |
data |
array
Optional. Data for populating the Message object. |
↳ name |
string
Required. Unique resource name of the AppConnection. The name is ignored when creating a AppConnection. |
↳ create_time |
Google\Protobuf\Timestamp
Output only. Timestamp when the resource was created. |
↳ update_time |
Google\Protobuf\Timestamp
Output only. Timestamp when the resource was last modified. |
↳ labels |
array|Google\Protobuf\Internal\MapField
Optional. Resource labels to represent user provided metadata. |
↳ display_name |
string
Optional. An arbitrary user-provided name for the AppConnection. Cannot exceed 64 characters. |
↳ uid |
string
Output only. A unique identifier for the instance generated by the system. |
↳ type |
int
Required. The type of network connectivity used by the AppConnection. |
↳ application_endpoint |
Google\Cloud\BeyondCorp\AppConnections\V1\AppConnection\ApplicationEndpoint
Required. Address of the remote application endpoint for the BeyondCorp AppConnection. |
↳ connectors |
array
Optional. List of [google.cloud.beyondcorp.v1main.Connector.name] that are authorised to be associated with this AppConnection. |
↳ state |
int
Output only. The current state of the AppConnection. |
↳ gateway |
Google\Cloud\BeyondCorp\AppConnections\V1\AppConnection\Gateway
Optional. Gateway used by the AppConnection. |
getName
Required. Unique resource name of the AppConnection.
The name is ignored when creating a AppConnection.
| Returns | |
|---|---|
| Type | Description |
string | |
setName
Required. Unique resource name of the AppConnection.
The name is ignored when creating a AppConnection.
| Parameter | |
|---|---|
| Name | Description |
var |
string
|
| Returns | |
|---|---|
| Type | Description |
$this | |
getCreateTime
Output only. Timestamp when the resource was created.
| Returns | |
|---|---|
| Type | Description |
Google\Protobuf\Timestamp|null | |
hasCreateTime
clearCreateTime
setCreateTime
Output only. Timestamp when the resource was created.
| Parameter | |
|---|---|
| Name | Description |
var |
Google\Protobuf\Timestamp
|
| Returns | |
|---|---|
| Type | Description |
$this | |
getUpdateTime
Output only. Timestamp when the resource was last modified.
| Returns | |
|---|---|
| Type | Description |
Google\Protobuf\Timestamp|null | |
hasUpdateTime
clearUpdateTime
setUpdateTime
Output only. Timestamp when the resource was last modified.
| Parameter | |
|---|---|
| Name | Description |
var |
Google\Protobuf\Timestamp
|
| Returns | |
|---|---|
| Type | Description |
$this | |
getLabels
Optional. Resource labels to represent user provided metadata.
| Returns | |
|---|---|
| Type | Description |
Google\Protobuf\Internal\MapField | |
setLabels
Optional. Resource labels to represent user provided metadata.
| Parameter | |
|---|---|
| Name | Description |
var |
array|Google\Protobuf\Internal\MapField
|
| Returns | |
|---|---|
| Type | Description |
$this | |
getDisplayName
Optional. An arbitrary user-provided name for the AppConnection. Cannot exceed 64 characters.
| Returns | |
|---|---|
| Type | Description |
string | |
setDisplayName
Optional. An arbitrary user-provided name for the AppConnection. Cannot exceed 64 characters.
| Parameter | |
|---|---|
| Name | Description |
var |
string
|
| Returns | |
|---|---|
| Type | Description |
$this | |
getUid
Output only. A unique identifier for the instance generated by the system.
| Returns | |
|---|---|
| Type | Description |
string | |
setUid
Output only. A unique identifier for the instance generated by the system.
| Parameter | |
|---|---|
| Name | Description |
var |
string
|
| Returns | |
|---|---|
| Type | Description |
$this | |
getType
Required. The type of network connectivity used by the AppConnection.
| Returns | |
|---|---|
| Type | Description |
int | |
setType
Required. The type of network connectivity used by the AppConnection.
| Parameter | |
|---|---|
| Name | Description |
var |
int
|
| Returns | |
|---|---|
| Type | Description |
$this | |
getApplicationEndpoint
Required. Address of the remote application endpoint for the BeyondCorp AppConnection.
| Returns | |
|---|---|
| Type | Description |
Google\Cloud\BeyondCorp\AppConnections\V1\AppConnection\ApplicationEndpoint|null | |
hasApplicationEndpoint
clearApplicationEndpoint
setApplicationEndpoint
Required. Address of the remote application endpoint for the BeyondCorp AppConnection.
| Parameter | |
|---|---|
| Name | Description |
var |
Google\Cloud\BeyondCorp\AppConnections\V1\AppConnection\ApplicationEndpoint
|
| Returns | |
|---|---|
| Type | Description |
$this | |
getConnectors
Optional. List of [google.cloud.beyondcorp.v1main.Connector.name] that are authorised to be associated with this AppConnection.
| Returns | |
|---|---|
| Type | Description |
Google\Protobuf\Internal\RepeatedField | |
setConnectors
Optional. List of [google.cloud.beyondcorp.v1main.Connector.name] that are authorised to be associated with this AppConnection.
| Parameter | |
|---|---|
| Name | Description |
var |
string[]
|
| Returns | |
|---|---|
| Type | Description |
$this | |
getState
Output only. The current state of the AppConnection.
| Returns | |
|---|---|
| Type | Description |
int | |
setState
Output only. The current state of the AppConnection.
| Parameter | |
|---|---|
| Name | Description |
var |
int
|
| Returns | |
|---|---|
| Type | Description |
$this | |
getGateway
Optional. Gateway used by the AppConnection.
| Returns | |
|---|---|
| Type | Description |
Google\Cloud\BeyondCorp\AppConnections\V1\AppConnection\Gateway|null | |
hasGateway
clearGateway
setGateway
Optional. Gateway used by the AppConnection.
| Parameter | |
|---|---|
| Name | Description |
var |
Google\Cloud\BeyondCorp\AppConnections\V1\AppConnection\Gateway
|
| Returns | |
|---|---|
| Type | Description |
$this | |