Reference documentation and code samples for the Google Cloud Telco Automation V1 Client class File.
File represents a yaml file present in a blueprint's package.
Generated from protobuf message google.cloud.telcoautomation.v1.File
Namespace
Google \ Cloud \ TelcoAutomation \ V1Methods
__construct
Constructor.
| Parameters | |
|---|---|
| Name | Description |
data |
array
Optional. Data for populating the Message object. |
↳ path |
string
Required. Path of the file in package. e.g. |
↳ content |
string
Optional. The contents of a file in string format. |
↳ deleted |
bool
Optional. Signifies whether a file is marked for deletion. |
↳ editable |
bool
Optional. Indicates whether changes are allowed to a file. If the field is not set, the file cannot be edited. |
getPath
Required. Path of the file in package.
e.g. gdce/v1/cluster.yaml
| Returns | |
|---|---|
| Type | Description |
string |
|
setPath
Required. Path of the file in package.
e.g. gdce/v1/cluster.yaml
| Parameter | |
|---|---|
| Name | Description |
var |
string
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getContent
Optional. The contents of a file in string format.
| Returns | |
|---|---|
| Type | Description |
string |
|
setContent
Optional. The contents of a file in string format.
| Parameter | |
|---|---|
| Name | Description |
var |
string
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getDeleted
Optional. Signifies whether a file is marked for deletion.
| Returns | |
|---|---|
| Type | Description |
bool |
|
setDeleted
Optional. Signifies whether a file is marked for deletion.
| Parameter | |
|---|---|
| Name | Description |
var |
bool
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getEditable
Optional. Indicates whether changes are allowed to a file. If the field is not set, the file cannot be edited.
| Returns | |
|---|---|
| Type | Description |
bool |
|
setEditable
Optional. Indicates whether changes are allowed to a file. If the field is not set, the file cannot be edited.
| Parameter | |
|---|---|
| Name | Description |
var |
bool
|
| Returns | |
|---|---|
| Type | Description |
$this |
|