Reference documentation and code samples for the Google Cloud BeyondCorp AppGateways V1 Client class AppGateway.
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.
Generated from protobuf message google.cloud.beyondcorp.appgateways.v1.AppGateway
Methods
__construct
Constructor.
| Parameters | |
|---|---|
| Name | Description |
data |
array
Optional. Data for populating the Message object. |
↳ name |
string
Required. Unique resource name of the AppGateway. The name is ignored when creating an AppGateway. |
↳ 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 AppGateway. 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 AppGateway. |
↳ state |
int
Output only. The current state of the AppGateway. |
↳ uri |
string
Output only. Server-defined URI for this resource. |
↳ allocated_connections |
array<Google\Cloud\BeyondCorp\AppGateways\V1\AppGateway\AllocatedConnection>
Output only. A list of connections allocated for the Gateway |
↳ host_type |
int
Required. The type of hosting used by the AppGateway. |
getName
Required. Unique resource name of the AppGateway.
The name is ignored when creating an AppGateway.
| Returns | |
|---|---|
| Type | Description |
string | |
setName
Required. Unique resource name of the AppGateway.
The name is ignored when creating an AppGateway.
| 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 AppGateway. Cannot exceed 64 characters.
| Returns | |
|---|---|
| Type | Description |
string | |
setDisplayName
Optional. An arbitrary user-provided name for the AppGateway. 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 AppGateway.
| Returns | |
|---|---|
| Type | Description |
int | |
setType
Required. The type of network connectivity used by the AppGateway.
| Parameter | |
|---|---|
| Name | Description |
var |
int
|
| Returns | |
|---|---|
| Type | Description |
$this | |
getState
Output only. The current state of the AppGateway.
| Returns | |
|---|---|
| Type | Description |
int | |
setState
Output only. The current state of the AppGateway.
| Parameter | |
|---|---|
| Name | Description |
var |
int
|
| Returns | |
|---|---|
| Type | Description |
$this | |
getUri
Output only. Server-defined URI for this resource.
| Returns | |
|---|---|
| Type | Description |
string | |
setUri
Output only. Server-defined URI for this resource.
| Parameter | |
|---|---|
| Name | Description |
var |
string
|
| Returns | |
|---|---|
| Type | Description |
$this | |
getAllocatedConnections
Output only. A list of connections allocated for the Gateway
| Returns | |
|---|---|
| Type | Description |
Google\Protobuf\Internal\RepeatedField | |
setAllocatedConnections
Output only. A list of connections allocated for the Gateway
| Parameter | |
|---|---|
| Name | Description |
var |
array<Google\Cloud\BeyondCorp\AppGateways\V1\AppGateway\AllocatedConnection>
|
| Returns | |
|---|---|
| Type | Description |
$this | |
getHostType
Required. The type of hosting used by the AppGateway.
| Returns | |
|---|---|
| Type | Description |
int | |
setHostType
Required. The type of hosting used by the AppGateway.
| Parameter | |
|---|---|
| Name | Description |
var |
int
|
| Returns | |
|---|---|
| Type | Description |
$this | |