Google Cloud Gke Backup V1 Client - Class CreateBackupPlanRequest (0.3.1)

Reference documentation and code samples for the Google Cloud Gke Backup V1 Client class CreateBackupPlanRequest.

Request message for CreateBackupPlan.

Generated from protobuf message google.cloud.gkebackup.v1.CreateBackupPlanRequest

Namespace

Google \ Cloud \ GkeBackup \ V1

Methods

__construct

Constructor.

Parameters
NameDescription
data array

Optional. Data for populating the Message object.

↳ parent string

Required. The location within which to create the BackupPlan. Format: projects/*/locations/*

↳ backup_plan Google\Cloud\GkeBackup\V1\BackupPlan

Required. The BackupPlan resource object to create.

↳ backup_plan_id string

Required. The client-provided short name for the BackupPlan resource. This name must: - be between 1 and 63 characters long (inclusive) - consist of only lower-case ASCII letters, numbers, and dashes - start with a lower-case letter - end with a lower-case letter or number - be unique within the set of BackupPlans in this location

getParent

Required. The location within which to create the BackupPlan.

Format: projects/*/locations/*

Returns
TypeDescription
string

setParent

Required. The location within which to create the BackupPlan.

Format: projects/*/locations/*

Parameter
NameDescription
var string
Returns
TypeDescription
$this

getBackupPlan

Required. The BackupPlan resource object to create.

Returns
TypeDescription
Google\Cloud\GkeBackup\V1\BackupPlan|null

hasBackupPlan

clearBackupPlan

setBackupPlan

Required. The BackupPlan resource object to create.

Parameter
NameDescription
var Google\Cloud\GkeBackup\V1\BackupPlan
Returns
TypeDescription
$this

getBackupPlanId

Required. The client-provided short name for the BackupPlan resource.

This name must:

  • be between 1 and 63 characters long (inclusive)
  • consist of only lower-case ASCII letters, numbers, and dashes
  • start with a lower-case letter
  • end with a lower-case letter or number
  • be unique within the set of BackupPlans in this location
Returns
TypeDescription
string

setBackupPlanId

Required. The client-provided short name for the BackupPlan resource.

This name must:

  • be between 1 and 63 characters long (inclusive)
  • consist of only lower-case ASCII letters, numbers, and dashes
  • start with a lower-case letter
  • end with a lower-case letter or number
  • be unique within the set of BackupPlans in this location
Parameter
NameDescription
var string
Returns
TypeDescription
$this

static::build

Parameters
NameDescription
parent string

Required. The location within which to create the BackupPlan. Format: projects/*/locations/* Please see Google\Cloud\GkeBackup\V1\BackupForGKEClient::locationName() for help formatting this field.

backupPlan Google\Cloud\GkeBackup\V1\BackupPlan

Required. The BackupPlan resource object to create.

backupPlanId string

Required. The client-provided short name for the BackupPlan resource. This name must:

  • be between 1 and 63 characters long (inclusive)
  • consist of only lower-case ASCII letters, numbers, and dashes
  • start with a lower-case letter
  • end with a lower-case letter or number
  • be unique within the set of BackupPlans in this location
Returns
TypeDescription
Google\Cloud\GkeBackup\V1\CreateBackupPlanRequest