Skip to content

Commit

Permalink
feat: add InitializeServiceAPI (#8002)
Browse files Browse the repository at this point in the history
feat: Update field behavior of `networks` field in message `ManagementServer` to `OPTIONAL`
feat: add enum to Backup Vault Access Restriction field
feat: `ignore_backup_plan_references` added to the DeleteBackupVaultRequest
fix!: Update field behavior of `resource_type` field in message `BackupPlanAssociation` to `REQUIRED`
docs: A comment for field `networks` in message `.google.cloud.backupdr.v1.ManagementServer` is changed
docs: A comment for field `requested_cancellation` in message `.google.cloud.backupdr.v1.OperationMetadata` is changed
docs: A comment for field `resource_type` in message `.google.cloud.backupdr.v1.BackupPlan` is changed
docs: A comment for field `backup_retention_days` in message `.google.cloud.backupdr.v1.BackupRule` is changed
docs: A comment for field `resource_type` in message `.google.cloud.backupdr.v1.BackupPlanAssociation` is changed
docs: A comment for field `data_source` in message `.google.cloud.backupdr.v1.BackupPlanAssociation` is changed
docs: A comment for field `rule_id` in message `.google.cloud.backupdr.v1.RuleConfigInfo` is changed
docs: A comment for field `last_backup_error` in message `.google.cloud.backupdr.v1.RuleConfigInfo` is changed
docs: A comment for enum value `ACCESS_RESTRICTION_UNSPECIFIED` in enum `AccessRestriction` is changed
docs: A comment for field `uid` in message `.google.cloud.backupdr.v1.BackupVault` is changed
docs: A comment for field `access_restriction` in message `.google.cloud.backupdr.v1.BackupVault` is changed
PiperOrigin-RevId: 713528070
Source-Link: googleapis/googleapis@8cd8706
Source-Link: googleapis/googleapis-gen@a5c65fa
Copy-Tag: eyJwIjoiQmFja3VwRHIvLk93bEJvdC55YW1sIiwiaCI6ImE1YzY1ZmFjZWJlOGQ1NTIzYWRlNjBmYTU1MDZiYzhjMzVkYWQ4NjgifQ==
  • Loading branch information
gcf-owl-bot[bot] authored Jan 9, 2025
1 parent e2e10c4 commit bef0f90
Show file tree
Hide file tree
Showing 24 changed files with 755 additions and 93 deletions.
Binary file modified BackupDr/metadata/V1/Backupdr.php
Binary file not shown.
Binary file modified BackupDr/metadata/V1/Backupplanassociation.php
Binary file not shown.
Binary file modified BackupDr/metadata/V1/Backupvault.php
Binary file not shown.
10 changes: 8 additions & 2 deletions BackupDr/samples/V1/BackupDRClient/create_backup_plan.php
Original file line number Diff line number Diff line change
Expand Up @@ -52,6 +52,12 @@
* @param int $backupPlanBackupRulesBackupRetentionDays Configures the duration for which backup data will be kept. It is
* defined in “days”. The value should be greater than or equal to minimum
* enforced retention of the backup vault.
*
* Minimum value is 1 and maximum value is 90 for hourly backups.
* Minimum value is 1 and maximum value is 90 for daily backups.
* Minimum value is 7 and maximum value is 186 for weekly backups.
* Minimum value is 30 and maximum value is 732 for monthly backups.
* Minimum value is 365 and maximum value is 36159 for yearly backups.
* @param int $backupPlanBackupRulesStandardScheduleRecurrenceType Specifies the `RecurrenceType` for the schedule.
* @param int $backupPlanBackupRulesStandardScheduleBackupWindowStartHourOfDay The hour of day (0-23) when the window starts for e.g. if value
* of start hour of day is 6 that mean backup window start at 6:00.
Expand All @@ -68,8 +74,8 @@
* See https://en.wikipedia.org/wiki/List_of_tz_database_time_zones for the
* list of valid timezone names. For e.g., Europe/Paris.
* @param string $backupPlanResourceType The resource type to which the `BackupPlan` will be applied.
* Examples include, "compute.googleapis.com/Instance" and
* "storage.googleapis.com/Bucket".
* Examples include, "compute.googleapis.com/Instance",
* "sqladmin.googleapis.com/Instance", or "alloydb.googleapis.com/Cluster".
* @param string $formattedBackupPlanBackupVault Resource name of backup vault which will be used as storage
* location for backups. Format:
* projects/{project}/locations/{location}/backupVaults/{backupvault}
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -39,6 +39,8 @@
* {@see BackupDRClient::locationName()} for help formatting this field.
* @param string $backupPlanAssociationId The name of the backup plan association to create. The name must
* be unique for the specified project and location.
* @param string $backupPlanAssociationResourceType Immutable. Resource type of workload on which backupplan is
* applied
* @param string $backupPlanAssociationResource Immutable. Resource name of workload on which backupplan is
* applied
* @param string $formattedBackupPlanAssociationBackupPlan Resource name of backup plan which needs to be applied on
Expand All @@ -49,6 +51,7 @@
function create_backup_plan_association_sample(
string $formattedParent,
string $backupPlanAssociationId,
string $backupPlanAssociationResourceType,
string $backupPlanAssociationResource,
string $formattedBackupPlanAssociationBackupPlan
): void {
Expand All @@ -57,6 +60,7 @@ function create_backup_plan_association_sample(

// Prepare the request message.
$backupPlanAssociation = (new BackupPlanAssociation())
->setResourceType($backupPlanAssociationResourceType)
->setResource($backupPlanAssociationResource)
->setBackupPlan($formattedBackupPlanAssociationBackupPlan);
$request = (new CreateBackupPlanAssociationRequest())
Expand Down Expand Up @@ -97,6 +101,7 @@ function callSample(): void
{
$formattedParent = BackupDRClient::locationName('[PROJECT]', '[LOCATION]');
$backupPlanAssociationId = '[BACKUP_PLAN_ASSOCIATION_ID]';
$backupPlanAssociationResourceType = '[RESOURCE_TYPE]';
$backupPlanAssociationResource = '[RESOURCE]';
$formattedBackupPlanAssociationBackupPlan = BackupDRClient::backupPlanName(
'[PROJECT]',
Expand All @@ -107,6 +112,7 @@ function callSample(): void
create_backup_plan_association_sample(
$formattedParent,
$backupPlanAssociationId,
$backupPlanAssociationResourceType,
$backupPlanAssociationResource,
$formattedBackupPlanAssociationBackupPlan
);
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -28,7 +28,6 @@
use Google\Cloud\BackupDR\V1\Client\BackupDRClient;
use Google\Cloud\BackupDR\V1\CreateManagementServerRequest;
use Google\Cloud\BackupDR\V1\ManagementServer;
use Google\Cloud\BackupDR\V1\NetworkConfig;
use Google\Rpc\Status;

/**
Expand All @@ -49,9 +48,7 @@ function create_management_server_sample(
$backupDRClient = new BackupDRClient();

// Prepare the request message.
$managementServerNetworks = [new NetworkConfig()];
$managementServer = (new ManagementServer())
->setNetworks($managementServerNetworks);
$managementServer = new ManagementServer();
$request = (new CreateManagementServerRequest())
->setParent($formattedParent)
->setManagementServerId($managementServerId)
Expand Down
89 changes: 89 additions & 0 deletions BackupDr/samples/V1/BackupDRClient/initialize_service.php
Original file line number Diff line number Diff line change
@@ -0,0 +1,89 @@
<?php
/*
* Copyright 2025 Google LLC
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
* https://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/

/*
* GENERATED CODE WARNING
* This file was automatically generated - do not edit!
*/

require_once __DIR__ . '/../../../vendor/autoload.php';

// [START backupdr_v1_generated_BackupDR_InitializeService_sync]
use Google\ApiCore\ApiException;
use Google\ApiCore\OperationResponse;
use Google\Cloud\BackupDR\V1\Client\BackupDRClient;
use Google\Cloud\BackupDR\V1\InitializeServiceRequest;
use Google\Cloud\BackupDR\V1\InitializeServiceResponse;
use Google\Rpc\Status;

/**
* Initializes the service related config for a project.
*
* @param string $name The resource name of the serviceConfig used to initialize the
* service. Format:
* `projects/{project_id}/locations/{location}/serviceConfig`.
* @param string $resourceType The resource type to which the default service config will be
* applied. Examples include, "compute.googleapis.com/Instance" and
* "storage.googleapis.com/Bucket".
*/
function initialize_service_sample(string $name, string $resourceType): void
{
// Create a client.
$backupDRClient = new BackupDRClient();

// Prepare the request message.
$request = (new InitializeServiceRequest())
->setName($name)
->setResourceType($resourceType);

// Call the API and handle any network failures.
try {
/** @var OperationResponse $response */
$response = $backupDRClient->initializeService($request);
$response->pollUntilComplete();

if ($response->operationSucceeded()) {
/** @var InitializeServiceResponse $result */
$result = $response->getResult();
printf('Operation successful with response data: %s' . PHP_EOL, $result->serializeToJsonString());
} else {
/** @var Status $error */
$error = $response->getError();
printf('Operation failed with error data: %s' . PHP_EOL, $error->serializeToJsonString());
}
} catch (ApiException $ex) {
printf('Call failed with message: %s' . PHP_EOL, $ex->getMessage());
}
}

/**
* Helper to execute the sample.
*
* This sample has been automatically generated and should be regarded as a code
* template only. It will require modifications to work:
* - It may require correct/in-range values for request initialization.
* - It may require specifying regional endpoints when creating the service client,
* please see the apiEndpoint client configuration option for more details.
*/
function callSample(): void
{
$name = '[NAME]';
$resourceType = '[RESOURCE_TYPE]';

initialize_service_sample($name, $resourceType);
}
// [END backupdr_v1_generated_BackupDR_InitializeService_sync]
16 changes: 8 additions & 8 deletions BackupDr/src/V1/BackupPlan.php

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

42 changes: 19 additions & 23 deletions BackupDr/src/V1/BackupPlanAssociation.php

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

20 changes: 20 additions & 0 deletions BackupDr/src/V1/BackupRule.php

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

Loading

0 comments on commit bef0f90

Please sign in to comment.