Google Cloud Dataform V1 Client - Class DeleteFolderTreeRequest (0.11.0)

Reference documentation and code samples for the Google Cloud Dataform V1 Client class DeleteFolderTreeRequest.

DeleteFolderTree request message.

Generated from protobuf message google.cloud.dataform.v1.DeleteFolderTreeRequest

Namespace

Google \ Cloud \ Dataform \ V1

Methods

__construct

Constructor.

Parameters
Name
Description
data
array

Optional. Data for populating the Message object.

↳ name
string

Required. The Folder's name. Format: projects/{project}/locations/{location}/folders/{folder}

↳ force
bool

Optional. If false (default): The operation will fail if any Repository within the folder hierarchy has associated Release Configs or Workflow Configs. If true : The operation will attempt to delete everything, including any Release Configs and Workflow Configs linked to Repositories within the folder hierarchy. This permanently removes schedules and resources.

getName

Required. The Folder's name.

Format: projects/{project}/locations/{location}/folders/{folder}

Returns
Type
Description
string

setName

Required. The Folder's name.

Format: projects/{project}/locations/{location}/folders/{folder}

Parameter
Name
Description
var
string
Returns
Type
Description
$this

getForce

Optional. If false (default): The operation will fail if any Repository within the folder hierarchy has associated Release Configs or Workflow Configs.

If true : The operation will attempt to delete everything, including any Release Configs and Workflow Configs linked to Repositories within the folder hierarchy. This permanently removes schedules and resources.

Returns
Type
Description
bool

setForce

Optional. If false (default): The operation will fail if any Repository within the folder hierarchy has associated Release Configs or Workflow Configs.

If true : The operation will attempt to delete everything, including any Release Configs and Workflow Configs linked to Repositories within the folder hierarchy. This permanently removes schedules and resources.

Parameter
Name
Description
var
bool
Returns
Type
Description
$this

static::build

Parameters
Name
Description
name
string

Required. The Folder's name. Format: projects/{project}/locations/{location}/folders/{folder} Please see DataformClient::folderName() for help formatting this field.

force
bool

Optional. If false (default): The operation will fail if any Repository within the folder hierarchy has associated Release Configs or Workflow Configs.

If true : The operation will attempt to delete everything, including any Release Configs and Workflow Configs linked to Repositories within the folder hierarchy. This permanently removes schedules and resources.

Returns
Type
Description
Create a Mobile Website
View Site in Mobile | Classic
Share by: