Reference documentation and code samples for the Google Cloud Ftp V1 Client class Server.
Message describing Server object
Generated from protobuf message google.cloud.ftp.v1.Server
Namespace
Google \ Cloud \ Ftp \ V1Methods
__construct
Constructor.
| Parameters | |
|---|---|
| Name | Description |
data |
array
Optional. Data for populating the Message object. |
↳ external_config |
ExternalServerConfig
Configuration for external access. |
↳ internal_config |
InternalServerConfig
Configuration for internal access. |
↳ name |
string
Identifier. name of resource |
↳ create_time |
Google\Protobuf\Timestamp
Output only. [Output only] Create time stamp |
↳ update_time |
Google\Protobuf\Timestamp
Output only. [Output only] Update time stamp |
↳ labels |
array|Google\Protobuf\Internal\MapField
Optional. Labels as key value pairs |
↳ display_name |
string
Optional. Display name of the Server |
↳ access_type |
int
Required. The access type of the Server. |
↳ state |
int
Output only. The state of the server. |
↳ google_managed_server_credential |
ServerCredential
Output only. Credentials of the FTP Server. |
↳ service_agent |
string
Output only. Service agent used to access the customer bucket. |
getExternalConfig
Configuration for external access.
| Returns | |
|---|---|
| Type | Description |
ExternalServerConfig|null |
|
hasExternalConfig
setExternalConfig
Configuration for external access.
| Parameter | |
|---|---|
| Name | Description |
var |
ExternalServerConfig
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getInternalConfig
Configuration for internal access.
| Returns | |
|---|---|
| Type | Description |
InternalServerConfig|null |
|
hasInternalConfig
setInternalConfig
Configuration for internal access.
| Parameter | |
|---|---|
| Name | Description |
var |
InternalServerConfig
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getName
Identifier. name of resource
| Returns | |
|---|---|
| Type | Description |
string |
|
setName
Identifier. name of resource
| Parameter | |
|---|---|
| Name | Description |
var |
string
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getCreateTime
Output only. [Output only] Create time stamp
| Returns | |
|---|---|
| Type | Description |
Google\Protobuf\Timestamp|null |
|
hasCreateTime
clearCreateTime
setCreateTime
Output only. [Output only] Create time stamp
| Parameter | |
|---|---|
| Name | Description |
var |
Google\Protobuf\Timestamp
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getUpdateTime
Output only. [Output only] Update time stamp
| Returns | |
|---|---|
| Type | Description |
Google\Protobuf\Timestamp|null |
|
hasUpdateTime
clearUpdateTime
setUpdateTime
Output only. [Output only] Update time stamp
| Parameter | |
|---|---|
| Name | Description |
var |
Google\Protobuf\Timestamp
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getLabels
Optional. Labels as key value pairs
| Returns | |
|---|---|
| Type | Description |
Google\Protobuf\Internal\MapField |
|
setLabels
Optional. Labels as key value pairs
| Parameter | |
|---|---|
| Name | Description |
var |
array|Google\Protobuf\Internal\MapField
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getDisplayName
Optional. Display name of the Server
| Returns | |
|---|---|
| Type | Description |
string |
|
setDisplayName
Optional. Display name of the Server
| Parameter | |
|---|---|
| Name | Description |
var |
string
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getAccessType
Required. The access type of the Server.
| Returns | |
|---|---|
| Type | Description |
int |
Enum of type AccessType. |
setAccessType
Required. The access type of the Server.
| Parameter | |
|---|---|
| Name | Description |
var |
int
Enum of type AccessType. |
| Returns | |
|---|---|
| Type | Description |
$this |
|
getState
Output only. The state of the server.
| Returns | |
|---|---|
| Type | Description |
int |
Enum of type State. |
setState
Output only. The state of the server.
| Parameter | |
|---|---|
| Name | Description |
var |
int
Enum of type State. |
| Returns | |
|---|---|
| Type | Description |
$this |
|
getGoogleManagedServerCredential
Output only. Credentials of the FTP Server.
| Returns | |
|---|---|
| Type | Description |
ServerCredential|null |
|
hasGoogleManagedServerCredential
clearGoogleManagedServerCredential
setGoogleManagedServerCredential
Output only. Credentials of the FTP Server.
| Parameter | |
|---|---|
| Name | Description |
var |
ServerCredential
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getServiceAgent
Output only. Service agent used to access the customer bucket.
| Returns | |
|---|---|
| Type | Description |
string |
|
setServiceAgent
Output only. Service agent used to access the customer bucket.
| Parameter | |
|---|---|
| Name | Description |
var |
string
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getAccessConfig
| Returns | |
|---|---|
| Type | Description |
string |
|